Créer et gérer des invitations utilisateur

Cette page explique comment effectuer certaines opérations fondamentales avec l'API User Invitation de Cloud Identity.

Avant de commencer

Remarque : Avant d'utiliser l'une des API Cloud Identity, vous devez configurer Cloud Identity. Pour obtenir des instructions, consultez la section Configurer Cloud Identity.

Effectuez les tâches suivantes avant d'utiliser les informations fournies sur cette page :

• Consultez la Présentation de l'API User Invitation.
• Configurez l'API User Invitation.

Déterminer l'éligibilité aux invitations

Comme indiqué dans la présentation, pour pouvoir être invité, un compte utilisateur doit répondre à plusieurs critères. Vous pouvez utiliser la méthode IsInvitableUser() pour déterminer si un compte utilisateur donné est éligible.

REST

Pour vérifier l'éligibilité d'un compte utilisateur, appelez customers.userinvitations.isInvitableUser() avec le numéro client et l'adresse e-mail du compte.

Exemple de demande

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

Récupérer des invitations d'utilisateurs

L'API User Invitation propose des méthodes de récupération d'une seule invitation utilisateur et de l'ensemble d'entre elles. Lorsque vous récupérez toutes les invitations des utilisateurs, vous pouvez éventuellement les filtrer par état et en définir l'ordre de tri.

Récupérer une invitation utilisateur

REST

Pour récupérer une seule invitation utilisateur, appelez customers.userinvitations.get() avec le numéro client et l'adresse e-mail du compte.

Exemple de demande

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

Récupérer une liste d'invitations d'utilisateurs

Tous les utilisateurs non gérés apparaissent automatiquement en tant qu'invitations à l'état NOT_YET_SENT jusqu'à ce que l'administrateur ou l'utilisateur final effectue une action. Une fois qu'un utilisateur accepte une invitation, le compte n'est plus considéré comme non géré.

• Si vous appelez customers.userinvitations.list() avec l'état de la requête, cela ne renvoie que les utilisateurs dont l'invitation se trouve dans cet état.
• Si vous appelez customers.userinvitations.list() sans l'état de la requête, cela renvoie les invitations de tous les utilisateurs.

Vous pouvez vérifier plusieurs états en ajoutant un opérateur or dans le filtre : state=='accepted'||state=='declined'

REST

Pour récupérer la liste des invitations d'utilisateurs, appelez customers.userinvitations.list() avec le numéro client et tous les paramètres de requête souhaités pour filtrer, trier et paginer les résultats. L'exemple suivant renvoie la liste de tous les utilisateurs non gérés, classés par ordre décroissant de l'heure de dernière mise à jour.

Exemple de demande

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

Envoyer des invitations d'utilisateurs

Les invitations d'utilisateurs ne sont pas automatiquement envoyées aux utilisateurs éligibles. Une fois que vous avez une liste des utilisateurs que vous souhaitez inviter, vous pouvez utiliser la méthode customers.userinvitations.send(). Une invitation sera également créée le cas échéant.

REST

Pour envoyer un e-mail d'invitation à un utilisateur, appelez la méthode customers.userinvitations.send() avec le numéro client et l'adresse e-mail du compte utilisateur.

Exemple de demande

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

Annuler des invitations d'utilisateurs

Vous pouvez annuler des invitations d'utilisateurs jusqu'à ce qu'elles soient acceptées ou refusées. Appelez la méthode customers.userinvitations.cancel() pour annuler une invitation.

REST

Pour annuler une invitation utilisateur, appelez customers.userinvitations.cancel() avec le numéro client et l'adresse e-mail du compte utilisateur.

Exemple de demande

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