type de ressource invitation

Espace de noms: microsoft.graph

Représente une invitation utilisée pour ajouter des utilisateurs externes à une organisation.

Le processus d’invitation utilise le flux suivant :

  • Une invitation est créée.
  • Une invitation (contenant un lien d’invitation) est envoyée à l’utilisateur invité.
  • L’utilisateur invité clique sur le lien d’invitation, se connecte et accepte l’invitation ; la création de l’entité utilisateur représentant l’utilisateur invité est terminée.
  • L’utilisateur est redirigé vers une page spécifique à l’issue de l’acceptation.

La création d’une invitation renverra une URL d’acceptation dans la réponse (inviteRedeemUrl). L’API de création d’invitation peut envoyer automatiquement un e-mail contenant l’URL d’acceptation à l’utilisateur invité, en définissant sendInvitationMessage sur true. Vous pouvez également personnaliser le message qui sera envoyé à l’utilisateur invité. En revanche, si vous souhaitez envoyer l’URL d’acceptation par d’autres moyens, vous pouvez définir sendInvitationMessage sur false et utiliser l’URL d’acceptation de la réponse pour créer votre propre communication. Il n’existe actuellement aucune API permettant d’exécuter le processus d’acceptation. L’utilisateur invité doit cliquer sur le lien inviteRedeemUrl envoyé dans la communication à l’étape ci-dessus et exécuter le processus d’acceptation interactif dans un navigateur. Une fois qu’il a terminé, l’utilisateur invité devient un utilisateur externe dans l’organisation.

Méthodes

Méthode Type renvoyé Description
Créer l’invitation invitation Écrivez des propriétés et des relations d’objet invitation.

Propriétés

Propriété Type Description
invitedUserDisplayName String Nom d’affichage de l’utilisateur invité.
invitedUserEmailAddress String Adresse e-mail de l’utilisateur invité. Obligatoire. Les caractères spéciaux suivants ne sont pas autorisés dans l’adresse e-mail :
  • Tilde (~)
  • Point d’exclamation (!)
  • Signe dièse (#)
  • Symbole dollar ($)
  • Pourcentage (%)
  • Accent circonflexe (^)
  • Esperluette (&)
  • Astérisque (*)
  • Parenthèses (( ))
  • Signe plus (+)
  • Signe égal (=)
  • Crochets ([ ])
  • Accolades ({ })
  • Barre oblique inverse (\)
  • Barre oblique (/)
  • Barre verticale (\|)
  • Point-virgule (;)
  • Deux-points (:)
  • Guillemets (")
  • Chevrons (< >)
  • Point d’interrogation (?)
  • Virgule (,)

Toutefois, les exceptions suivantes s’appliquent :
  • Un point (.) ou un tiret (-) est autorisé n’importe où dans le nom d’utilisateur, sauf au début ou à la fin du nom.
  • Un trait de soulignement (_) est autorisé n’importe où dans le nom d’utilisateur. Cela comprend le début ou la fin du nom.
invitedUserMessageInfo invitedUserMessageInfo Configuration supplémentaire du message envoyé à l’utilisateur invité, notamment personnalisation du texte, de la langue et de la liste de destinataires Cc du message.
sendInvitationMessage Boolean Indique si un e-mail doit être envoyé à l’utilisateur invité. La valeur par défaut est false.
inviteRedirectUrl String URL vers laquelle l’utilisateur doit être redirigé une fois l’invitation acceptée. Obligatoire.
inviteRedeemUrl String L’URL que les utilisateurs peuvent utiliser pour la gestion de leur invitation. Lecture seule.
invitedUserType String UserType de l’utilisateur invité. Par défaut, cette valeur est Guest. Vous pouvez inviter en tant que Member si vous êtes administrateur d’entreprise.
status String Le statut de l’invitation. Les valeurs possibles sont : PendingAcceptance, Completed, InProgress, et Error

Relations

Relation Type Description
invitedUser User Utilisateur créé dans le cadre de la création de l’invitation. Lecture seule

Représentation JSON

Voici une représentation JSON de la ressource

{
  "invitedUserDisplayName": "string",
  "invitedUserEmailAddress": "string",
  "invitedUserMessageInfo": {"@odata.type": "microsoft.graph.invitedUserMessageInfo"},
  "sendInvitationMessage": false,
  "inviteRedirectUrl": "string",
  "inviteRedeemUrl": "string",
  "status": "string",
  "invitedUser": {"@odata.type": "microsoft.graph.user"},
  "invitedUserType": "string"
}