Partager via

Mettre à jour 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 .

Mettez à jour les propriétés d’un objet agentUser .

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

Autorisations pour des scénarios spécifiques

  • Votre compte Microsoft personnel doit être lié à un locataire Microsoft Entra pour mettre à jour votre profil avec l’autorisation déléguée User.ReadWrite sur un compte Microsoft personnel.
  • Pour mettre à jour la propriété employeeLeaveDateTime :
    • Dans les scénarios délégués, l’administrateur a besoin du rôle Administrateur général ; L’application doit disposer des autorisations déléguées User.Read.All et User-LifeCycleInfo.ReadWrite.All .
    • Dans les scénarios d’application uniquement avec des autorisations Microsoft Graph, l’application doit disposer des autorisations User.Read.All et User-LifeCycleInfo.ReadWrite.All .
  • Pour mettre à jour la propriété customSecurityAttributes :
    • Dans les scénarios délégués, l’administrateur doit se voir attribuer le rôle Administrateur d’attribution d’attributs et l’application doit disposer de l’autorisation CustomSecAttributeAssignment.ReadWrite.All .
    • Dans les scénarios d’application uniquement avec des autorisations Microsoft Graph, l’application doit disposer de l’autorisation CustomSecAttributeAssignment.ReadWrite.All .
  • User-Mail.ReadWrite.All est l’autorisation la moins privilégiée pour mettre à jour la propriété otherMails .
  • User-PasswordProfile.ReadWrite.All est l’autorisation la moins privilégiée pour mettre à jour la propriété passwordProfile .
  • User-Phone.ReadWrite.All est l’autorisation la moins privilégiée pour mettre à jour les propriétés businessPhones et mobilePhone .
  • User.EnableDisableAccount.All + User.Read.All est la combinaison d’autorisations la moins privilégiée pour mettre à jour la propriété accountEnabled .
  • User.ManageIdentities.All est nécessaire pour mettre à jour la propriété identities .

Requête HTTP

PATCH /users/microsoft.graph.agentUser/{userId}

Conseil

Vous pouvez également mettre à jour les utilisateurs de l’agent via le point de terminaison PATCH /users/{id} sans spécifier le microsoft.graph.agentUser type.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Vous devez spécifier le @odata.type comme #microsoft.graph.agentUser dans le corps de la requête lors de la mise à jour d’un agentUser.

Propriété Type Description
accountEnabled Boolean true si le compte est activé ; sinon, false. Cette propriété est requise lorsqu’un utilisateur d’agent est créé.
assignedLicenses collection assignedLicense Licences attribuées à l’utilisateur de l’agent. Ne pouvant accepter la valeur null.
businessPhones String collection Numéros de téléphone de l’utilisateur de l’agent. NOTE: Bien qu’il s’agisse d’une collection de chaînes, un seul nombre peut être défini pour cette propriété.
Ville String Ville dans laquelle se trouve l’utilisateur de l’agent.
CompanyName String Nom de la société à laquelle l’utilisateur de l’agent est associé. Cette propriété peut être utile pour décrire la société d’où provient un utilisateur d’agent externe. La longueur maximale est de 64 caractères.
country String Pays/région dans lequel se trouve l’utilisateur de l’agent ; par exemple, US ou UK.
Service String Nom du service dans lequel l’utilisateur de l’agent travaille.
displayName String Nom affiché dans le carnet d’adresses de l’utilisateur de l’agent. Cette propriété est requise lorsqu’un utilisateur d’agent est créé et qu’elle ne peut pas être effacée pendant les mises à jour.
employeeId String Identificateur d’employé affecté à l’utilisateur de l’agent par le organization. La longueur maximale est de 16 caractères.
employeeType String Capture le type de travailleur d’entreprise. Par exemple, Employee, Contractor, Consultant ou Vendor.
givenName String Nom (prénom) de l’utilisateur de l’agent.
employeeHireDate DateTimeOffset Date d’embauche de l’utilisateur de l’agent. Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z.
employeeLeaveDateTime DateTimeOffset Date et heure auxquelles l’utilisateur de l’agent a quitté ou quittera le organization. Le type d’horodatage représente les informations de date et d’heure au format ISO 8601 et est toujours en heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z.
employeeOrgData employeeOrgData Représente organization données (par exemple, division et costCenter) associées à l’utilisateur de l’agent. Incluez les deux valeurs de propriété lors de la mise à jour de employeeOrgData ; Si vous en omettez, le système les définit sur null.
jobTitle String Fonction de l’utilisateur de l’agent.
messagerie String Adresse SMTP de l’utilisateur de l’agent, par exemple . salesagent@contoso.com Les modifications apportées à cette propriété met également à jour la collection proxyAddresses de l’utilisateur de l’agent pour inclure la valeur en tant qu’adresse SMTP. Impossible de mettre à jour vers null.
mailNickname String Alias de messagerie de l’utilisateur de l’agent. Cette propriété doit être spécifiée lors de la création d’un utilisateur d’agent.
mobilePhone String Numéro de téléphone cellulaire principal de l’utilisateur de l’agent.
officeLocation String Emplacement du bureau dans le lieu de travail de l’utilisateur de l’agent.
otherMails Collection de chaînes Une liste d’adresses e-mail supplémentaires pour l’utilisateur de l’agent ; par exemple : ["salesagent@contoso.com", "agentsales@fabrikam.com"]. Pour mettre à jour cette propriété, transmettez toutes les adresses e-mail que vous souhaitez que l’utilisateur de l’agent ait ; sinon, les valeurs existantes sont remplacées par les valeurs que vous spécifiez. Peut stocker jusqu’à 250 valeurs, chacune avec une limite de 250 caractères.
postalCode String Code postal de l’adresse postale de l’utilisateur de l’agent. Le code postal est spécifique au pays/à la région de l’utilisateur de l’agent. Aux États-Unis d’Amérique, cet attribut contient le code ZIP.
preferredLanguage String Langue par défaut pour l’utilisateur de l’agent. Doit respecter le Code ISO 639-1 ; par exemple en-US.
state String État ou province dans l’adresse de l’utilisateur de l’agent.
streetAddress String Adresse postale du lieu d’activité de l’utilisateur de l’agent.
surname String Nom de famille ou nom de famille de l’utilisateur de l’agent.
usageLocation String Code pays à deux lettres (norme ISO 3166). Obligatoire pour les utilisateurs de l’agent auxquels des licences seront attribuées en raison de l’obligation légale de case activée pour la disponibilité des services dans les pays/régions. Les exemples incluent US, JP, et GB. Ne peut accepter une valeur null.
userPrincipalName String Nom d’utilisateur principal (UPN) de l’utilisateur de l’agent. L’UPN est un nom de connexion de style 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 d’accentuation. 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.
userType String Valeur de chaîne qui peut être utilisée pour classer les types d’utilisateur dans votre répertoire, tels que Member et Guest.

Étant donné que la ressource agentUser prend en charge les extensions, vous pouvez utiliser l’opération PATCH pour ajouter, mettre à jour ou supprimer vos propres données spécifiques à l’application dans les propriétés personnalisées d’une extension dans un instance agentUser existant.

Gérer les extensions et les données associées

Utilisez cette API pour gérer le répertoire, le schéma et les extensions d’ouverture, ainsi que leurs données pour les utilisateurs de l’agent, comme suit :

  • Ajouter, mettre à jour et stocker des données dans les extensions d’un utilisateur d’agent existant
  • Pour les extensions de répertoire et de schéma, supprimez toutes les données stockées en définissant la valeur de la propriété d’extension personnalisée sur null. Pour les extensions ouvertes, utilisez l’API Supprimer une extension ouverte.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet agentUser mis à jour dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/users/microsoft.graph.agentUser/{userId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.agentUser",
  "accountEnabled": true,
  "assignedLicenses": [
    {
      "@odata.type": "microsoft.graph.assignedLicense"
    }
  ],
  "businessPhones": [
    "+1 425 555 0109"
  ],
  "city": "Seattle",
  "companyName": "Contoso",
  "country": "United States",
  "department": "Sales",
  "displayName": "Sales Agent",
  "employeeId": "12345",
  "employeeType": "Agent",
  "givenName": "Sales",
  "employeeHireDate": "2024-01-15T00:00:00Z",
  "employeeLeaveDateTime": null,
  "employeeOrgData": {
    "@odata.type": "microsoft.graph.employeeOrgData",
    "division": "Sales Division",
    "costCenter": "1234"
  },
  "jobTitle": "Sales Agent",
  "mail": "salesagent@contoso.com",
  "mailNickname": "SalesAgent",
  "mobilePhone": "+1 425 555 0110",
  "officeLocation": "18/2111",
  "otherMails": [
    "salesagent@contoso.com"
  ],
  "postalCode": "98052",
  "preferredLanguage": "en-US",
  "state": "WA",
  "streetAddress": "9256 Towne Center Dr., Suite 400",
  "surname": "Agent",
  "usageLocation": "US",
  "userPrincipalName": "salesagent@contoso.com",
  "userType": "Member"
}

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.agentUser",
  "id": "929393ae-1e1d-159f-0d83-29f7df42e7b9",
  "signInActivity": {
    "@odata.type": "microsoft.graph.signInActivity"
  },
 "cloudLicensing": {
      "@odata.type": "microsoft.graph.cloudLicensing.userCloudLicensing"
    },
    "accountEnabled": "Boolean",
    "ageGroup": null,
    "assignedLicenses": [
      {
        "@odata.type": "microsoft.graph.assignedLicense"
      }
    ],
    "assignedPlans": [
      {
        "@odata.type": "microsoft.graph.assignedPlan"
      }
    ],
    "authorizationInfo": null,
    "businessPhones": [
      "String"
    ],
    "city": "String",
    "cloudRealtimeCommunicationInfo": {
      "@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
    },
    "companyName": "String",
    "consentProvidedForMinor": null,
    "country": "String",
    "createdDateTime": "String (timestamp)",
    "creationType": "String",
    "department": "String",
    "displayName": "String",
    "employeeHireDate": "String (timestamp)",
    "employeeId": "String",
    "employeeOrgData": {
      "@odata.type": "microsoft.graph.employeeOrgData"
    },
    "employeeType": "String",
    "employeeLeaveDateTime": "String (timestamp)",
    "faxNumber": "String",
    "givenName": "String",
    "identities": [
      {
        "@odata.type": "microsoft.graph.objectIdentity"
      }
    ],
    "imAddresses": [
      "String"
    ],
    "infoCatalogs": [
      "String"
    ],
    "isLicenseReconciliationNeeded": "Boolean",
    "isManagementRestricted": "Boolean",
    "isResourceAccount": "Boolean",
    "jobTitle": "String",
    "lastPasswordChangeDateTime": null,
    "legalAgeGroupClassification": null,
    "licenseAssignmentStates": [
      {
        "@odata.type": "microsoft.graph.licenseAssignmentState"
      }
    ],
    "mail": "String",
    "mailNickname": "String",
    "mobilePhone": "String",
    "onPremisesDistinguishedName": null,
    "onPremisesExtensionAttributes": null,
    "onPremisesImmutableId": null,
    "onPremisesLastSyncDateTime": null,
    "onPremisesProvisioningErrors": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSipInfo": null,
    "onPremisesSyncEnabled": null,
    "onPremisesDomainName": null,
    "onPremisesSamAccountName": null,
    "onPremisesUserPrincipalName": null,
    "otherMails": [
      "String"
    ],
    "passwordPolicies": null,
    "passwordProfile": null,
    "officeLocation": "String",
    "postalCode": "String",
    "preferredDataLocation": "String",
    "preferredLanguage": "String",
    "provisionedPlans": [
      {
        "@odata.type": "microsoft.graph.provisionedPlan"
      }
    ],
    "proxyAddresses": [
      "String"
    ],
    "refreshTokensValidFromDateTime": "String (timestamp)",
    "securityIdentifier": "String",
    "serviceProvisioningErrors": [
      {
        "@odata.type": "microsoft.graph.serviceProvisioningXmlError"
      }
    ],
    "showInAddressList": "Boolean",
    "signInSessionsValidFromDateTime": "String (timestamp)",
    "state": "String",
    "streetAddress": "String",
    "surname": "String",
    "usageLocation": "String",
    "userPrincipalName": "String",
    "externalUserState": null,
    "externalUserStateChangeDateTime": null,
    "userType": "String",
    "identityParentId": "String",
    "mailboxSettings": {
      "@odata.type": "microsoft.graph.mailboxSettings"
    },
    "aboutMe": "String",
    "birthday": "String (timestamp)",
    "interests": [
      "String"
    ],
    "mySite": "String",
    "pastProjects": [
      "String"
    ],
    "preferredName": "String",
    "responsibilities": [
      "String"
    ],
    "schools": [
      "String"
    ],
    "skills": [
      "String"
    ]
  }
  • Last updated on