Créer et gérer des invitations

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

Avant de commencer

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

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

Déterminer l'éligibilité d'une invitation

Comme indiqué dans la présentation, une invitation doit être envoyée à un compte utilisateur pour répondre à plusieurs critères. Vous pouvez utiliser la méthode IsInvitableUser() pour savoir 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/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:isInvitableUser

Récupérer des invitations utilisateur

L'API User Invite fournit des méthodes permettant de récupérer une invitation unique et de toutes les récupérer. Lorsque vous récupérez toutes les invitations d'utilisateurs, vous pouvez éventuellement les filtrer par état et définir l'ordre de tri.

Récupérer une seule invitation d'utilisateur

REST

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

Exemple de demande

GET https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com

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 agisse explicitement. Une fois qu'une invitation a été acceptée par l'utilisateur, le compte n'est plus considéré comme non géré.

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, appelez customers.userinvitations.list() avec le numéro client et 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 date de dernière mise à jour, dans l'ordre décroissant.

Exemple de demande

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

Envoi d'invitations d'utilisateur

Les invitations utilisateur ne sont pas automatiquement envoyées aux utilisateurs éligibles. Une fois que vous disposez d'une liste des utilisateurs que vous souhaitez inviter, vous pouvez utiliser la méthode customers.userinvitations.send(). Une invitation sera également créée si elle n'existe pas.

REST

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

Exemple de demande

POST https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:send

Annulation des invitations...

Les invitations utilisateur peuvent être annulées jusqu'à ce qu'elles soient acceptées ou refusées. Appelez la méthode customers.userinvites.cancel() pour annuler une invitation.

REST

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

Exemple de demande

POST https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:cancel