Partager via

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 requête.

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

Cette opération retourne par défaut 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 de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

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

Type d’autorisation Autorisation avec privilèges minimum Autorisations privilégiées plus élevées
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

Les autorisations AgentIdentity* ne sont actuellement pas disponibles pour le consentement via l’expérience d’autorisations d’API sur le centre d’administration Microsoft Entra. Pour utiliser ces autorisations, vous pouvez y donner votre consentement par le biais d’appels Microsoft API Graph, comme décrit dans Accorder ou révoquer des autorisations d’API par programmation. Pour plus d’informations sur ces autorisations, consultez Autorisations pour la gestion des identités d’agent .

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’administrateur doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération.

  • Administrateur d’ID d’agent

Requête HTTP

POST /users/microsoft.graph.agentUser

Conseil

Vous pouvez également créer des utilisateurs d’agent via post /users sans spécifier le microsoft.graph.agentUser type. Toutefois, "@odata.type": "microsoft.graph.agentUser" doit être spécifié dans le corps de la demande avec d’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 l’autorisation.
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 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 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 être mappé au nom de l’e-mail 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é d’agent associée. 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’utilisateur de l’agent instance lors de sa création.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un 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 retourne 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