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 de la collaboration entreprise-entreprise (Microsoft Entra B2B) Microsoft Entra.
Le processus d’invitation utilise le flux suivant :
- Une invitation est créée.
- Une invitation qui contient un lien d’invitation est envoyée à l’utilisateur invité.
- L’utilisateur invité sélectionne le lien d’invitation, se connecte et accepte 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 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 surtrue. 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 sendInvitationMessagefalse sur et utiliser l’URL d’échange 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
L’état de l’invitation est suivi à l’aide des propriétés externalUserState et externalUserStateChangeDateTime sur la ressource d’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 :
Toutefois, les exceptions suivantes s’appliquent :
|
| invitedUserMessageInfo | invitedUserMessageInfo | Contins informations de configuration pour le message envoyé à l’utilisateur invité, y compris la personnalisation du texte du message, de la langue et de la liste de destinataires cc. |
| inviteRedirectUrl | String | L’URL de l’utilisateur doit être redirigée vers une fois l’invitation utilisé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 êtes administrateur d’entreprise. La valeur par défaut est false. |
| resetRedemption | Valeur booléenne | Réinitialisez l’état 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. Quand truela valeur est , la relationd’ID d’utilisateur/invitéest requise. Pour plus d’informations sur l’utilisation de cette propriété, consultez Réinitialiser l’état 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, InProgress, et Error |
Relations
| Relation | Type | Description |
|---|---|---|
| invitedUser | utilisateur | L’utilisateur a 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 état d’échange. |
| 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.
{
"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"
}