命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
获取 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 |
HTTP 请求
GET /users/microsoft.graph.AgentUser
可选的查询参数
此方法支持 OData 查询参数 来帮助自定义响应:
-
$count,$expand,$filter,$orderby,$search,$select,$top. 不支持$skip。 -
页面大小限制: 默认页面大小为 100 个对象。 最大页面大小为 999 个对象,除非使用
$select=signInActivity或$filter=signInActivity,最大页面大小为 500。 - 某些查询需要将 ConsistencyLevel 标头设置为
eventual和$count。 有关详细信息,请参阅 目录对象的高级查询功能。
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此方法在响应正文中返回响应 200 OK 代码和 agentUser 对象的集合。
示例
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/users/microsoft.graph.agentUser
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"value":
{
"@odata.type": "#microsoft.graph.agentUser",
"id": "84e0b4dc-e852-29ed-1e5d-9e1f335611e8",
"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"
]
}
}