type de ressource invitation

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Représente une invitation utilisée pour ajouter des utilisateurs externes à une organisation dans le cadre d’une collaboration entreprise-entreprise (B2B) dans l’ID externe Microsoft Entra.

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é sélectionne le lien d’invitation, se connecte et utilise l’invitation, et l’entité utilisateur qui représente l’utilisateur invité est créée.
  • L’utilisateur est redirigé vers une page spécifique une fois l’échange terminé.

La création d’une invitation renvoie une URL de remboursement dans la réponse (inviteRedeemUrl). L’API de création d’invitation peut envoyer automatiquement un e-mail contenant l’URL de remboursement à 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 de remboursement par un autre moyen, vous pouvez définir sendInvitationMessage sur false et utiliser l’URL de remboursement de la réponse pour créer votre propre communication. Actuellement, aucune API n’est disponible pour effectuer le processus d’échange. L’utilisateur invité doit sélectionner le lien inviteRedeemUrl envoyé dans la communication et suivre le processus d’échange interactif dans un navigateur. Une fois le processus terminé, l’utilisateur invité devient un utilisateur externe dans l’organisation.

Remarque

Le status de l’invitation est suivi à l’aide des propriétés externalUserState et externalUserStateChangeDateTime sur la ressource utilisateur externe créée dans le cadre de la demande d’invitation.

Méthodes

Méthode Type renvoyé Description
Créer invitation Créez un objet d’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 (!)
  • Arobase (@)
  • Signe dièse (#)
  • Symbole dollar ($)
  • Pourcentage (%)
  • Accent circonflexe (^)
  • Esperluette (&)
  • Astérisque (*)
  • Parenthèses (( ))
  • Trait d'union (-)
  • 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 Contient des informations de configuration pour le message envoyé à l’utilisateur invité, notamment la personnalisation du texte, de la langue et de la liste des destinataires cc.
inviteRedirectUrl String L’utilisateur de l’URL doit être redirigé une fois l’invitation échangée. Obligatoire.
inviteRedeemUrl String URL dont l’utilisateur peut se servir pour accepter son invitation. En lecture seule.
invitedUserType String UserType de l’utilisateur invité. Par défaut, cette valeur est Guest. Vous pouvez inviter comme Member si vous étiez un administrateur d’entreprise. La valeur par défaut est false.
resetRedemption Booléen Réinitialisez le status d’échange de l’utilisateur et réinvitez un utilisateur tout en conservant son identificateur d’utilisateur, ses appartenances à des groupes et ses attributions d’application. Cette propriété vous permet d’autoriser un utilisateur à se connecter à l’aide d’une adresse de messagerie différente de celle de l’invitation précédente. Lorsque true, la relation d’ID invitedUser/ est requise. Pour plus d’informations sur l’utilisation de cette propriété, consultez Réinitialiser le 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. Valeurs possibles : PendingAcceptance, Completed, InProgresset Error

Relations

Relation Type Description
invitedUser utilisateur Utilisateur créé dans le cadre de la création de l’invitation. En lecture seule. La propriété id est requise dans le corps de la demande pour réinitialiser un status d’échange.
invitedUserSponsors collection directoryObject Les utilisateurs ou les groupes qui parrainent l’utilisateur invité. Les sponsors sont des utilisateurs et des groupes 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.

{
  "id": "String",
  "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"
}
  • Last updated on