Creazione e gestione di inviti per gli utenti

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

Prima di iniziare

Nota: prima di utilizzare le API Cloud Identity, devi configurare e Cloud Identity. Consulta la sezione Configurare Cloud Identity per istruzioni.

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

• Leggi Panoramica dell'API User Invitation.
• Imposta API User Invitation.

Determinazione dell'idoneità per gli inviti

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

REST

Per verificare l'idoneità di un account utente, chiama 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 in corso

L'API User Invitation fornisce metodi per recuperare un singolo utente un invito e il recupero di tutti questi elementi. Quando recuperi tutti gli inviti degli utenti, se vuoi puoi filtrarli per stato e impostare l'ordine di 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 nell'NOT_YET_SENT finché non viene intervenuto diversamente dall'amministratore o dall'utente finale. Una volta accettato un invitato, 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 all'utente.

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 i parametri di ricerca desiderati per filtrare, ordinare e impaginare i risultati. L'esempio seguente restituisce un elenco di tutti gli utenti non gestiti, ordinati in ordine decrescente in base all'ora dell'ultimo aggiornamento.

Richiesta di esempio

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

Invio di inviti agli utenti

Gli inviti agli utenti non vengono inviati automaticamente agli utenti idonei. Una volta che hai un 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 customers.userinvitations.cancel() per annullare un invito.

REST

Per annullare l'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