type de ressource invitation

  • Article

Espace de noms: microsoft.graph

Représente une invitation utilisée pour ajouter des utilisateurs externes à un organization dans le cadre de Microsoft Entra collaboration interentreprises (Microsoft Entra B2B).

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 renvoie une URL d’échange dans la réponse (inviteRedeemUrl). L’API de création d’invitation peut envoyer automatiquement un e-mail contenant l’URL d’échange à l’utilisateur invité, en définissant sendInvitationMessage sur true. Vous pouvez également personnaliser le message envoyé à l’utilisateur invité. Au lieu de cela, si vous souhaitez envoyer l’URL d’échange par d’autres moyens, vous pouvez définir sendInvitationMessage sur false et utiliser l’URL d’échange de la réponse pour créer votre propre communication. Actuellement, il n’existe aucune API pour effectuer le processus d’échange. L’utilisateur invité doit cliquer sur le lien inviteRedeemUrl envoyé à l’étape de communication et suivre le processus d’échange interactif dans un navigateur. Une fois terminé, l’utilisateur invité devient un utilisateur externe dans le organization.

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, y compris au début ou à la fin du nom.
invitedUserMessageInfo invitedUserMessageInfo Configuration supplémentaire pour le message envoyé à l’utilisateur invité, notamment la personnalisation du texte du message, de la langue et de la liste des destinataires cc.
invitedUserType String UserType de l’utilisateur invité. Par défaut, cette valeur est Guest. Vous pouvez inviter comme Member si vous êtes administrateur d’entreprise.
inviteRedirectUrl String URL vers laquelle l’utilisateur doit être redirigé une fois l’invitation utilisée. Obligatoire.
inviteRedeemUrl String URL dont l’utilisateur peut se servir pour accepter son invitation. En lecture seule.
resetRedemption Valeur booléenne Réinitialisez la status d’échange de l’utilisateur et réinvitez un utilisateur tout en conservant son identificateur d’utilisateur, ses appartenances aux groupes et ses attributions d’application. Cette propriété vous permet de permettre à un utilisateur de se connecter à l’aide d’une adresse e-mail différente de celle de l’invitation précédente. Pour plus d’informations sur l’utilisation de cette propriété, consultez Réinitialiser l’status d’échange pour un utilisateur invité.
sendInvitationMessage Boolean Indique si un e-mail doit être envoyé à l’utilisateur invité. La valeur par défaut est false.
status String Le statut de l’invitation. Les valeurs possibles sont : PendingAcceptance, Completed, InProgress, et Error

Relations

Relation Type Description
invitedUser User L’utilisateur a créé dans le cadre de la création de l’invitation. Lecture seule
invitedUserSponsors collection directoryObject Utilisateurs ou groupes qui sont des sponsors de l’utilisateur invité. Les sponsors sont des utilisateurs et des groupes qui sont responsables des privilèges des utilisateurs invités dans le locataire et de la mise à jour des informations et de l’accès des utilisateurs invités.

Représentation JSON

La représentation JSON suivante montre le type de ressource.

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