Envoyer des invitations d’appartenance à une organisation

Découvrez comment envoyer des invitations d’appartenance à une organisation à l’aide de l’Auth0 Dashboard ou de la Management API.

Vous pouvez envoyer aux utilisateurs des invitations d’appartenance à une organisation en utilisant soit le Auth0 Dashboard, soit la Management API.

​

Auth0 Dashboard

Pour inviter des membres dans l’Auth0 Dashboard :

1. Accédez à Auth0 Dashboard > Organizations, puis sélectionnez l’organisation pour laquelle vous souhaitez gérer l’appartenance.

2. Sélectionnez la vue Invitations, puis Invite Members.

3. Sélectionnez l’application à laquelle vous souhaitez inviter le membre, saisissez l’adresse de courriel de l’utilisateur que vous souhaitez inviter dans l’organisation, puis sélectionnez Send Invite(s).

   Au besoin, vous pouvez préciser la connexion que les utilisateurs devront utiliser pour accepter l’invitation, ainsi que les rôles à attribuer au membre de l’organisation lorsqu’il l’accepte.

Si vous activez Domaines personnalisés multiples, vous pouvez sélectionner Domaine dans la section Send Invite(s) afin de choisir le domaine de notification de votre locataire.

​

Management API

Si vous exposez la fonctionnalité d’invitation dans un tableau de bord d’administration personnalisé pour votre application, utilisez une application confidentielle pour valider que l’utilisateur authentifié appartient à une organisation avant d’inviter de nouveaux membres, ou limitez la possibilité d’inviter de nouveaux membres aux utilisateurs auxquels un rôle précis est attribué.

Pour inviter des membres au moyen de la Management API : Effectuez un appel POST au point de terminaison Create Organization Invitations. Assurez-vous de remplacer les valeurs d’espace réservé ORG_ID, MGMT_API_ACCESS_TOKEN, NAME_OF_USER, EMAIL_ADDRESS, CLIENT_ID, CONNECTION_ID, EXP_TIME, ROLE_ID et SEND_INVITATION_EMAIL_OPTION par l’ID de votre organisation, le Jeton d’accès de la Management API, le nom de l’utilisateur invité, l’adresse de courriel de l’utilisateur invité, l’ID client, l’ID de la connexion, la durée d’expiration et les ID de rôle, respectivement.

{
  "method": "POST",
  "url": "https://{yourDomain}/api/v2/organizations/ORG_ID/invitations",
"headers": [
  { "name": "Content-Type", "value": "application/json" },
  { "name": "Authorization", "value": "Bearer MGMT_API_ACCESS_TOKEN" },
  { "name": "Cache-Control", "value": "no-cache" }
  ],
  "postData": {
  "mimeType": "application/json",
  "text" : "{ \"inviter\": { \"name\": \"NAME_OF_USER\"}, \"invitee\": { \"email\": \"EMAIL_ADDRESS\" }, \"client_id\": \"CLIENT_ID\", \"connection_id\": \"CONNECTION_ID\", \"ttl_sec\": \"EXP_TIME\", \"roles\": [ \"ROLE_ID\", \"ROLE_ID\", \"ROLE_ID\" ], \"send_invitation_email\": \"SEND_EMAIL_INVITATION_OPTION\" }"
  }
}

Si vous activez Domaines personnalisés multiples, vous devez inclure l’en-tête HTTP auth0-custom-domain. Pour en savoir plus, consultez Domaines personnalisés multiples.

Trouvez votre domaine Auth0

Votre domaine Auth0 est composé du nom de votre locataire, de votre sous-domaine régional (à moins que votre locataire soit dans la région des États-Unis et ait été créé avant juin 2020), puis de .auth0.com. Par exemple, si le nom de votre locataire était travel0, votre domaine Auth0 serait travel0.us.auth0.com. (Si votre locataire était aux États-Unis et avait été créé avant juin 2020, votre nom de domaine serait alors https://travel0.auth0.com.)

Si vous utilisez des domaines personnalisés, il doit s’agir du nom de votre domaine personnalisé.

Valeur	Description
ORG_ID	ID de l’organisation pour laquelle vous voulez attribuer l’appartenance.
MGMT_API_ACCESS_TOKEN	Jeton d’accès pour la Management API avec le scope create:organization_invitations.
NAME_OF_USER	Nom de l’utilisateur à qui vous voulez envoyer l’invitation. Maximum de 300 caractères.
EMAIL_ADDRESS	Adresse de courriel à laquelle l’invitation doit être envoyée.
CLIENT_ID	ID de l’application auprès de laquelle l’utilisateur invité doit s’authentifier.
CONNECTION_ID	ID de la connexion par laquelle le membre invité doit s’authentifier.
EXP_TIME	Nombre de secondes avant l’expiration de l’invitation. Si aucune valeur n’est précisée ou si elle est définie à 0, la valeur par défaut est de 604800 secondes (7 jours). Maximum de 2592000 secondes (30 jours).
ROLE_ID	ID du ou des rôles que vous voulez attribuer à l’utilisateur invité pour l’organisation indiquée. Maximum de 50 rôles par membre.
SEND_INVITATION_EMAIL_OPTION	Indique si Auth0 doit envoyer le courriel. Les valeurs sont true ou false. Lorsqu’elle est définie à false, Auth0 génère une URL d’invitation que vous pouvez transmettre aux utilisateurs au moyen de votre propre service de courriel.

​

Codes d’état de réponse

Les codes d’état de réponse possibles sont les suivants :

Code d’état	Code d’erreur	Message	Cause
200		Invitation créée avec succès.
400	invalid_body	Le client_id spécifié n’existe pas.	Le payload de la requête n’est pas valide.
400	invalid_body	La connexion spécifiée n’existe pas.	Le payload de la requête n’est pas valide.
400	invalid_body	Les connexions Passwordless ne sont pas prises en charge.	Le payload de la requête n’est pas valide.
400	invalid_body	Une route de connexion par défaut est requise pour générer l’URL d’invitation. Pour en savoir plus, consultez Configure default login routes.	Le payload de la requête n’est pas valide.
400	invalid_body	Un ou plusieurs des rôles spécifiés n’existent pas : role1, role2’.	Le payload de la requête n’est pas valide.
400	invalid_body	Corps de requête non valide. Le message varie selon la cause.	Le payload de la requête n’est pas valide.
400	invalid_query_string	Chaîne de requête non valide. Le message varie selon la cause.	La chaîne de requête n’est pas valide.
401		Jeton invalide.
401		Signature invalide reçue lors de la validation du JSON Web Token.
401		L’application n’est pas globale.
403	insufficient_scope	scope insuffisant ; un des scopes suivants est requis : create:organization_invitations.	Tentative de lire ou d’écrire un champ non autorisé avec les scopes du Bearer Token fournis.
404		Aucune organisation trouvée pour cet id.
429		Trop de requêtes. Vérifiez les en-têtes X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset.