Envoyer des invitations d’adhésion à une organisation

Vous pouvez envoyer des invitations d’adhésion à une organisation aux utilisateurs à l’aide du Auth0 Dashboard ou de Management API.

Auth0 Dashboard

Pour inviter des membres via Auth0 Dashboard :

  1. Naviguez à Tableau de bord Auth0 > Organizations et sélectionnez l’organisation pour laquelle vous souhaitez configurer l’appartenance.

  2. Sélectionnez la vue Invitations, et sélectionnez Inviter les membres.

  3. Sélectionnez l’application à laquelle vous désirez inviter le membre, entrez l’adresse courriel de l’utilisateur que vous désirez inviter dans l’organisation, et sélectionnez Envoyer invite(s).

Management API

Pour inviter des membres via Management API : Réalisez un appel POST au point de terminaison Créer des invitations d’organisation. Assurez-vous de remplacer les valeurs des espaces réservés ORG_ID, MGMT_API_ACCESS_TOKEN, NAME_OF_USER, EMAIL_ADDRESS, CLIENT_ID, CONNECTION_ID, EXP_TIME, ROLE_ID, et SEND_INVITATION_EMAIL_OPTION avec l’identification de votre organisation, le jeton d’accès à Management API, le nom de l’utilisateur invité, l’adresse courriel de l’utilisateur invité, l’ID client, l’identification de la connexion, le temps d’expiration, et l’identification du rôle..

{
  "method": "POST",
  "url": "https://YOUR_AUTH0_DOMAIN/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\" }"
  }
}

Was this helpful?

/

Valeur Description
ORG_ID ID de l’organisation à laquelle vous souhaitez attribuer l’adhésion.
MGMT_API_ACCESS_TOKEN Jeton d’accès pour Management API avec la permission create:organization_invitations.
NAME_OF_USER Nom de l’utilisateur à qui vous voulez envoyer l’invitation. 300 caractères au maximum.
EMAIL_ADDRESS Adresse courriel à laquelle l’invitation doit être envoyée.
CLIENT_ID ID de l’application à laquelle l’utilisateur invité doit s’authentifier.
CONNECTION_ID ID de la connexion via laquelle le membre invité doit s’authentifier.
EXP_TIME Nombre de secondes avant l’expiration de l’invitation. Si le délai n’est pas précisé, ou s’il est défini sur 0, la valeur par défaut est 604 800 secondes (7 jours). Le délai maximum est de 2 592 000 secondes (30 jours).
ROLE_ID Identifiant du ou des rôles que vous souhaitez attribuer à l’utilisateur invité pour l’organisation spécifié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. Lorsque la valeur est définie sur false, Auth0 générera une URL d’invitation que vous pourrez envoyer aux utilisateurs par votre propre service de messagerie.

Codes d’état des réponses

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 indiqué n’existe pas. La charge utile de la requête n’est pas valide.
400 invalid_body La connexion indiquée n’existe pas. La charge utile de la requête est invalide.
400 invalid_body Les connexions sans mot de passe ne sont pas prises en charge. La charge utile de la requête est invalide.
400 invalid_body Une route connexion par défaut est requise pour générer l’URL de l’invitation. Pour en apprendre davantage, consultez Configurer les routes de connexion par défaut. La charge utile de la requête est invalide..
400 invalid_body Un ou plusieurs des rôles indiqués n’existent pas : role1, role2’. La charge utile de la requête est invalide..
400 invalid_body Corps de la requête invalide. Le message variera selon la cause. La charge utile de la requête est invalide..
400 invalid_query_string Chaîne de la requête invalide. Le message variera selon la cause.. La chaîne de la requête est invalide.
401 Jeton invalide.
401 Signature non valide reçue pour la validation du jeton Web JSON.
401 Le client n’est pas global.
403 insufficient_scope Permission insuffisante; étaient attendus l’un des éléments suivants : create:organization_invitations. Tentative de lecture/écriture sur un champ qui n’est pas autorisé avec les permissions de jeton du porteur fourni.
404 Aucune Organization correspondant à cet identifiant trouvée.
429 Trop de requêtes. Vérifiez les en-têtes X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset.