Créer l’invitation

Espace de noms: microsoft.graph

Utilisez cette API pour créer une invitation. L’invitation ajoute un utilisateur externe à l’organisation.

Lorsque vous créez une invitation, plusieurs options sont disponibles :

  1. Lors de la création de l’invitation, Microsoft Graph peut envoyer automatiquement une invitation par e-mail directement à l’utilisateur invité, ou votre application peut utiliser l’élément inviteRedeemUrl renvoyé dans la réponse relative à la création pour créer votre propre invitation (par l’intermédiaire du mécanisme de communication de votre choix) à l’utilisateur invité. Si vous optez pour l’envoi automatique par Microsoft  Graph d’une invitation par e-mail, vous pouvez contrôler le contenu et la langue de l’e-mail à l’aide de invitedUserMessageInfo.
  2. Une fois l’utilisateur invité, une entité utilisateur (userType défini sur Invité) est créée et peut désormais être utilisée pour contrôler l’accès aux ressources. L’utilisateur invité doit suivre le processus d’échange pour accéder aux ressources auxquelles il a été invité.

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire) User.Invite.All, User.ReadWrite.All, Directory.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge.
Application User.Invite.All, User.ReadWrite.All, Directory.ReadWrite.All

Requête HTTP

POST /invitations

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire.
Content-Type application/json

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON d’un objet invitation.

Le tableau suivant indique les propriétés qui sont requises lorsque vous créez une invitation.

Paramètre Type Description
invitedUserEmailAddress string Adresse e-mail de l’utilisateur que vous invitez.
inviteRedirectUrl string URL vers laquelle l’utilisateur sera redirigé après l’acceptation.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 201 Created et un objet invitation dans le corps de la réponse.

Exemple

Demande

Voici un exemple de demande.

POST https://graph.microsoft.com/v1.0/invitations
Content-type: application/json

{
  "invitedUserEmailAddress": "admin@fabrikam.com",
  "inviteRedirectUrl": "https://myapp.contoso.com"
}

Réponse

Voici un exemple de réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#invitations/$entity",
  "id": "7b92124c-9fa9-406f-8b8e-225df8376ba9",
  "inviteRedeemUrl": "https://invitations.microsoft.com/redeem/?tenant=04dcc6ab-388a-4559-b527-fbec656300ea&user=7b92124c-9fa9-406f-8b8e-225df8376ba9&ticket=VV9dmiExBsfRIVNFjb9ITj9VXAd07Ypv4gTg%2f8PiuJs%3d&lc=1033&ver=2.0",
  "invitedUserDisplayName": "Fabrikam Admin",
  "invitedUserEmailAddress": "admin@fabrikam.com",
  "sendInvitationMessage": false,
  "invitedUserMessageInfo": {
     "messageLanguage": null,
     "ccRecipients": [
          {
             "emailAddress": {
                 "name": null,
                 "address": null
              }
          }
     ],
     "customizedMessageBody": null
  },
  "inviteRedirectUrl": "https://myapp.contoso.com",
  "status": "Completed",
  "invitedUser": { "id": "243b1de4-ad9f-421c-a933-d55305fb165d" }
}