Get agentUser

Namespace: microsoft.graph

Lesen Sie die Eigenschaften und Beziehungen des agentUser-Objekts .

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungen für bestimmte Szenarien

• So lesen Sie die employeeLeaveDateTime-Eigenschaft :
  • In delegierten Szenarien benötigt der angemeldete Benutzer mindestens eine der folgenden Microsoft Entra-Rollen: Lifecycle Workflows Administrator (niedrigste Rechte), globaler Leser; der App muss die delegierte Berechtigung User-LifeCycleInfo.Read.All erteilt werden.
  • In Nur-App-Szenarien mit Microsoft Graph-Berechtigungen muss der App die Berechtigung User-LifeCycleInfo.Read.All erteilt werden.
• So lesen Sie die customSecurityAttributes-Eigenschaft :
  • In delegierten Szenarien muss dem angemeldeten Benutzer die Rolle des Attributzuweisungsadministrators zugewiesen und der App die Berechtigung CustomSecAttributeAssignment.Read.All erteilt werden.
  • In Nur-App-Szenarien mit Microsoft Graph-Berechtigungen muss der App die Berechtigung CustomSecAttributeAssignment.Read.All erteilt werden.
• Um die managerApplications-Eigenschaft zu lesen, muss der App in delegierten Geschäfts-, Schul- oder Unikontenszenarien oder Anwendungsszenarien die Berechtigung "User.Read.All " oder " Directory.Read.All " mit höheren Berechtigungen erteilt werden. Delegierte persönliche Microsoft-Konten werden für diese Eigenschaft nicht unterstützt.

HTTP-Anforderung

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

Sie können die Basisbenutzereigenschaften eines Agent-Benutzers ohne GET /users/{user-id} Typumwandlung abrufen. Um managerApplications abzurufen, verwenden Sie das microsoft.graph.agentUser Typumwandlungssegment und schließen Sie die Eigenschaft explizit in $selectein.

Optionale Abfrageparameter

Diese Methode unterstützt die $select$expand OData-Abfrageparameter, um die Antwort anzupassen. Allgemeine Informationen finden Sie unter OData-Abfrageparameter.

Die Eigenschaft managerApplications wird nur zurückgegeben, wenn sie explizit ausgewählt wird. Sie unterstützt $filter keine Navigationseigenschaft und ist keine Navigationseigenschaft, gilt also $expand nicht dafür.

Anforderungsheader

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 200 OK Antwortcode und ein agentUser-Objekt im Antworttext zurück.

Beispiele

Beispiel 1: Abrufen eines Benutzer-Agents

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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"
    ]
  }
}

Beispiel 2: Abrufen von Manageranwendungen

Im folgenden Beispiel wird die Umwandlungsfunktion des abgeleiteten Typs verwendet und $select zum Abrufen der Anwendungs-IDs, die für die Verwaltung der zugrunde liegenden Agent-Blaupause des Agent-Benutzers autorisiert sind. Die Eigenschaft managerApplications wird vom Server verwaltet und ist schreibgeschützt. Um diese Werte zu ändern, aktualisieren Sie die Blaupause des Unterstützungsagenten anstelle des Agentenbenutzers.

Anforderung

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

Antwort

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"
  ]
}

Beispiel 3: Abrufen von Manageranwendungen, wenn keine konfiguriert sind

Wenn keine Manager-Anwendungen auf dem Backing Agent-Blueprint konfiguriert sind, gibt managerApplications eine leere Auflistung zurück, nicht null.

Anforderung

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

Antwort

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": []
}