Creazione e gestione di inviti per gli utenti

Questa pagina spiega come eseguire alcune operazioni fondamentali con l'API Cloud Identity User Invite.

Prima di iniziare

Nota: prima di utilizzare le API Cloud Identity, devi configurare Cloud Identity. Per le istruzioni, consulta Configurazione di Cloud Identity.

Prima di procedere con le informazioni in questa pagina, esegui le operazioni seguenti:

• Leggi la panoramica dell'API User Inviti.
• Configura l'API User Invito.

Determinare l'idoneità degli inviti

Come indicato nella panoramica, per essere invitato un account utente deve soddisfare più criteri. Puoi utilizzare il metodo IsInvitableUser() per scoprire se un determinato account utente è idoneo.

REST

Per verificare l'idoneità di un account utente, chiama il numero customers.userinvitations.isInvitableUser() con l'ID cliente e l'indirizzo email dell'account.

Richiesta di esempio

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:isInvitableUser

Recupero degli inviti degli utenti

L'API User Invito fornisce metodi per recuperare un singolo invito di un utente e recuperarli tutti. Quando recuperi tutti gli inviti degli utenti, puoi filtrarli per stato e impostare l'ordinamento.

Recupero dell'invito di un singolo utente

REST

Per recuperare l'invito di un singolo utente, chiama customers.userinvitations.get() con l'ID cliente e l'indirizzo email dell'account.

Richiesta di esempio

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]

Recupero di un elenco di inviti di utenti

Tutti gli utenti non gestiti vengono visualizzati automaticamente come inviti nello stato NOT_YET_SENT, salvo diversa azione da parte dell'amministratore o dell'utente finale. Una volta che l'invito viene accettato dall'utente, l'account non è più considerato non gestito.

• Se chiami customers.userinvitations.list() con lo stato nella richiesta, verranno restituiti solo gli utenti il cui invito è in quello stato.
• Se chiami customers.userinvitations.list() senza lo stato nella richiesta, verranno restituiti tutti gli inviti degli utenti.

Puoi verificare la presenza di più stati aggiungendo un operatore or nel filtro: state=='accepted'||state=='declined'

REST

Per recuperare un elenco di inviti di utenti, chiama customers.userinvitations.list() con l'ID cliente e gli eventuali parametri di ricerca desiderati per filtrare, ordinare e suddividere i risultati in pagine. L'esempio seguente restituisce un elenco di tutti gli utenti non gestiti, ordinati in base all'ora dell'ultimo aggiornamento in ordine decrescente.

Richiesta di esempio

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'

Invio di inviti di utenti in corso...

Gli inviti degli utenti non vengono inviati automaticamente agli utenti idonei. Una volta creato l'elenco degli utenti che vuoi invitare, puoi utilizzare il metodo customers.userinvitations.send(). Verrà creato anche un invito se non esiste.

REST

Per inviare un'email di invito a un utente, chiama customers.userinvitations.send() con l'ID cliente e l'indirizzo email dell'account utente.

Richiesta di esempio

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:send

Annullamento degli inviti degli utenti

Gli inviti degli utenti possono essere annullati finché non vengono accettati o rifiutati. Chiama il metodo customers.userinvitations.cancel() per annullare un invito.

REST

Per annullare un invito di un utente, chiama customers.userinvitations.cancel() con l'ID cliente e l'indirizzo email dell'account utente.

Richiesta di esempio

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:cancel