Creazione e gestione di inviti per gli utenti
Questa pagina spiega come eseguire alcune operazioni fondamentali con l'API User Invitation di Cloud Identity.
Prima di iniziare
Nota: prima di utilizzare una qualsiasi delle API Cloud Identity, devi configurare Cloud Identity. Per le istruzioni, vedi Configurare Cloud Identity.
Prima di procedere con le informazioni riportate in questa pagina, esegui le seguenti attività:
- Leggi la panoramica dell'API User Invitation.
- Configura l'API User Invitation.
Determinare l'idoneità all'invito
Come indicato nella panoramica,
per essere invitato, un account utente deve soddisfare più criteri. Puoi utilizzare il
IsInvitableUser()
metodo 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/writer@altostrat.com:isInvitableUser
Recuperare gli inviti degli utenti
L'API User Invitation fornisce metodi per recuperare un singolo invito utente e recuperarli tutti. Quando recuperi tutti gli inviti utente, puoi facoltativamente filtrarli per stato e impostare l'ordinamento.
Recuperare un singolo invito utente
REST
Per recuperare un singolo invito 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/writer@altostrat.com
Recuperare un elenco di inviti utente
Tutti gli utenti non gestiti vengono visualizzati automaticamente come inviti nello stato NOT_YET_SENT finché l'amministratore o l'utente finale non intraprendono altre azioni. Una volta che l'utente accetta un invito, l'account non viene più considerato non gestito.
- Se chiami
customers.userinvitations.list()con lo stato nella richiesta, verranno restituiti solo gli utenti il cui invito è in questo stato. - Se chiami
customers.userinvitations.list()senza lo stato nella richiesta, verranno restituiti tutti gli inviti utente.
Puoi verificare più stati aggiungendo un operatore or nel filtro:
state=='accepted'||state=='declined'
REST
Per recuperare un elenco di inviti utente, chiama
customers.userinvitations.list()
con l'ID cliente e tutti 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 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 utente
Gli inviti utente non vengono inviati automaticamente agli utenti idonei. Una volta che hai un
elenco degli utenti che vuoi invitare, puoi utilizzare il
customers.userinvitations.send() metodo.
Verrà creato anche un invito se non esiste.
REST
Per inviare un'email di invito utente 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/writer@altostrat.com:send
Annullamento degli inviti utente
Gli inviti utente possono essere annullati finché non vengono accettati o rifiutati. Chiama il customers.userinvitations.cancel() per annullare un invito.
REST
Per annullare un invito 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/writer@altostrat.com:cancel