Obtenir agentUser

Espace de noms: microsoft.graph

Lisez les propriétés et les relations de l’objet agentUser .

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) User.ReadBasic.All User.Read.All, 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 User.ReadBasic.All User.Read.All, AgentIdUser.ReadWrite.IdentityParentedBy, AgentIdUser.ReadWrite.All, User.ReadWrite.All

Autorisations pour des scénarios spécifiques

  • Pour lire la propriété employeeLeaveDateTime :
    • Dans les scénarios délégués, l’utilisateur connecté a besoin d’au moins un des rôles Microsoft Entra suivants : Administrateur des workflows du cycle de vie (moindre privilège), Lecteur général ; l’application doit disposer de l’autorisation déléguée User-LifeCycleInfo.Read.All.
    • Dans les scénarios d’application uniquement avec des autorisations Microsoft Graph, l’application doit disposer de l’autorisation User-LifeCycleInfo.Read.All .
  • Pour lire la propriété customSecurityAttributes :
    • Dans les scénarios délégués, le rôle d’administrateur de l’attribution d’attributs doit être attribué à l’utilisateur connecté et l’application doit disposer de l’autorisation CustomSecAttributeAssignment.Read.All .
    • Dans les scénarios d’application uniquement avec des autorisations Microsoft Graph, l’application doit disposer de l’autorisation CustomSecAttributeAssignment.Read.All .
  • Pour lire la propriété managerApplications , l’application doit disposer de l’autorisation User.Read.All ou Directory.Read.All avec les privilèges les plus élevés dans les scénarios de compte professionnel ou scolaire délégué ou les scénarios d’application. Les comptes Microsoft personnels délégués ne sont pas pris en charge pour cette propriété.

Requête HTTP

GET /users/microsoft.graph.agentUser/{userId}
GET /users/{user-id}/microsoft.graph.agentUser?$select=id,managerApplications

Vous pouvez récupérer les propriétés utilisateur de base d’un utilisateur d’agent sans GET /users/{user-id} conversion de type. Pour récupérer managerApplications, utilisez le microsoft.graph.agentUser segment de conversion de type et incluez explicitement la propriété dans $select.

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de $select requête et $expand OData pour personnaliser la réponse. Pour des informations générales, consultez paramètres de la requête OData.

La propriété managerApplications est renvoyée uniquement lorsqu’elle est sélectionnée de manière explicite. Elle ne prend pas en charge $filter et n’est pas une propriété de navigation, donc $expand ne s’applique pas à elle.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

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

Exemples

Exemple 1 : obtenir un utilisateur agent

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/users/microsoft.graph.agentUser/929393ae-1e1d-159f-0d83-29f7df42e7b9

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

{
  "value": {
    "@odata.type": "#microsoft.graph.agentUser",
    "id": "929393ae-1e1d-159f-0d83-29f7df42e7b9",
    "deletedDateTime": "String (timestamp)",
    "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"
    ]
  }
}

Exemple 2 : Obtenir des applications de gestionnaire

L’exemple suivant utilise le cast de type dérivé pour $select récupérer les ID d’application autorisés à gérer le blueprint de l’agent de backing de l’utilisateur. La propriété managerApplications est gérée par le serveur et en lecture seule. Pour modifier ces valeurs, mettez à jour le blueprint de l’agent de support au lieu de l’utilisateur de l’agent.

Demande

GET https://graph.microsoft.com/v1.0/users/11111111-2222-3333-4444-555555555555/microsoft.graph.agentUser?$select=id,managerApplications

Réponse

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/microsoft.graph.agentUser(id,managerApplications)/$entity",
  "@odata.type": "#microsoft.graph.agentUser",
  "id": "11111111-2222-3333-4444-555555555555",
  "managerApplications": [
    "631a96bc-a705-4eda-9f99-fdaf9f54f6a2",
    "742b07cd-b806-4feb-b009-9eaf0f55f7b3"
  ]
}

Exemple 3 : obtenir les applications du gestionnaire lorsqu’aucune n’est configurée

Lorsqu’aucune application gestionnaire n’est configurée sur le blueprint de l’agent de sauvegarde, managerApplications retourne une collection vide, pas null.

Demande

GET https://graph.microsoft.com/v1.0/users/11111111-2222-3333-4444-555555555555/microsoft.graph.agentUser?$select=managerApplications

Réponse

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/microsoft.graph.agentUser(managerApplications)/$entity",
  "@odata.type": "#microsoft.graph.agentUser",
  "managerApplications": []
}
  • Dernière mise à jour :