名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
agentUser オブジェクトのプロパティとリレーションシップを読み取ります。
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 | 最小特権アクセス許可 | より高い特権のアクセス許可 |
|---|---|---|
| 委任 (職場または学校のアカウント) | User.ReadBasic.All | User.Read.All、AgentIdUser.ReadWrite.IdentityParentedBy、AgentIdUser.ReadWrite.All、User.ReadWrite.All |
| 委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
| アプリケーション | User.ReadBasic.All | User.Read.All、AgentIdUser.ReadWrite.IdentityParentedBy、AgentIdUser.ReadWrite.All、User.ReadWrite.All |
特定のシナリオのアクセス許可
-
employeeLeaveDateTime プロパティを読み取る方法:
- 委任されたシナリオでは、サインインしているユーザーには、ライフサイクル ワークフロー管理者 (最小特権)、グローバル 閲覧者の少なくとも 1 つのMicrosoft Entraロールが必要です。アプリには User-LifeCycleInfo.Read.All 委任されたアクセス許可が付与されている必要があります。
- Microsoft Graph のアクセス許可を持つアプリのみのシナリオでは、アプリに User-LifeCycleInfo.Read.All アクセス許可を付与する必要があります。
-
customSecurityAttributes プロパティを読み取る方法:
- 委任されたシナリオでは、サインインしているユーザーに 属性割り当て管理者ロールを割り当て 、アプリに CustomSecAttributeAssignment.Read.All アクセス許可が付与されている必要があります。
- Microsoft Graph のアクセス許可を持つアプリのみのシナリオでは、アプリに CustomSecAttributeAssignment.Read.All アクセス許可を付与する必要があります。
HTTP 要求
GET /users/microsoft.graph.agentUser/{userId}
注: エージェント ユーザーの情報は、標準ユーザーのエンドポイント GET /users/userId を介して取得できます。 要求で特別な odata 型を指定する必要はありません。
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに役立つ OData クエリ パラメーターの $select と $expand をサポートします。 一般的な情報については、「OData クエリ パラメーター」を参照してください。
要求ヘッダー
| 名前 | 説明 |
|---|---|
| Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK 応答コードと、応答本文の agentUser オブジェクトを返します。
例
要求
次の例は要求を示しています。
GET https://graph.microsoft.com/beta/users/microsoft.graph.agentUser/929393ae-1e1d-159f-0d83-29f7df42e7b9
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
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"
]
}
}