Créer agentUser

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 .

Créez un objet agentUser . Vous pouvez également créer un utilisateur agent en utilisant le point de terminaison POST /users et en spécifiant le microsoft.graph.agentUser type dans le corps de la demande.

Vous devez spécifier au minimum les propriétés requises. Vous pouvez aussi spécifier d’autres propriétés accessibles en écriture.

Par défaut, cette opération renvoie uniquement un sous-ensemble des propriétés de chaque agentUser. Ces propriétés par défaut sont indiquées dans la section Propriétés. Pour obtenir des propriétés qui ne sont pas renvoyées par défaut, effectuez une opération GET et spécifiez les propriétés dans une option de requête OData $select.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.

Type d’autorisation Autorisation de moindre privilège Autorisations à privilèges plus élevés
Déléguée (compte professionnel ou scolaire) AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’administrateur doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. ID d’agent Administrateur est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

POST /users/microsoft.graph.agentUser

Conseil

Vous pouvez également créer des utilisateurs d’agent via le POST /users sans spécifier le microsoft.graph.agentUser type. Toutefois, elles "@odata.type": "microsoft.graph.agentUser" doivent être spécifiées dans le corps de la demande avec les autres propriétés requises pour la création de l’utilisateur.

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
Content-Type application/json

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON de l’objet agentUser .

Le tableau suivant répertorie les propriétés qui sont requises lorsque vous créez un agentUser.

Paramètre Type Description
accountEnabled Boolean true si le compte est activé ; sinon, false.
displayName String Nom à afficher dans le carnet d’adresses de l’utilisateur de l’agent.
mailNickname String Alias de messagerie de l’utilisateur de l’agent.
userPrincipalName String Le nom d’utilisateur principal (someagent@contoso.com). Il s’agit d’un nom de connexion de type Internet pour l’utilisateur de l’agent basé sur la norme Internet RFC 822. Par convention, cela doit correspondre au nom de messagerie de l’utilisateur de l’agent. Le format général est alias@domaine, où le domaine doit être présent dans la collection de domaines vérifiés du client. Les domaines vérifiés du client sont accessibles à partir de la propriété verifiedDomains de l’organisation.
REMARQUE : cette propriété ne peut pas contenir de caractères accentués. Seuls les caractères suivants sont autorisés A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. Pour obtenir la liste complète des caractères autorisés, consultez stratégies de nom d’utilisateur.
identityParentId String ID d’objet de l’identité de l’agent associé. Obligatoire.

Étant donné que cette ressource prend en charge les extensions, vous pouvez utiliser l’opération POST et ajouter des propriétés personnalisées avec vos propres données à l’instance utilisateur de l’agent lors de sa création.

Réponse

En cas de réussite, cette méthode renvoie un code de réponse et un 201 Created objet agentUser dans le corps de la réponse.

La tentative de création d’un agentUser avec un identityParentId déjà lié à un autre agentUser renvoie une 400 Bad Request erreur.

Exemples

Demande

L’exemple suivant illustre une demande.

POST https://graph.microsoft.com/beta/users/microsoft.graph.agentUser
Content-type: application/json

{
  "accountEnabled": true,
  "displayName": "Sales Agent",
  "mailNickname": "SalesAgent",
  "userPrincipalName": "salesagent@contoso.com",
  "identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Réponse

L’exemple suivant illustre la réponse.

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/beta/$metadata#users/$entity",
    "@odata.type": "#microsoft.graph.agentUser",
    "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
    "businessPhones": [],
    "displayName": "Sales Agent",
    "mail": "salesagent@contoso.com",
    "mailNickname": "SalesAgent",
    "userPrincipalName": "salesagent@contoso.com",
    "identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Contenu connexe

  • Last updated on