Manage account profiles - Get user members by role

服务:

Partner Center Rest

API 版本:

v1

获取限制为特定大小的角色用户成员的段。

GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers

具有可选参数:

GET https://api.partnercenter.microsoft.com/v{version}/roles/{role_id}/usermembers?size={size}&sortField={sortField}&sortDirection={sortDirection}&seekOperation={seekOperation}

URI 参数

名称	在	必需	类型	说明
role_id	path	True	string	角色标识符。
version	path	True	string	Api 版本。
seekOperation	query		string	要对角色的用户成员执行的查找操作。这对于需要下一页或上一页的用户成员的分页方案非常有用。
size	query		integer int32	要返回的最大用户成员数，值不应超过 500，不应小于 1
sortDirection	query		string	要排序的方向的可选排序参数，接受的值为升序和降序，默认值为升序
sortField	query		string	要排序依据的字段的可选排序参数，接受的值是 DisplayName 和 UserPrincipalName，默认值为 UserPrincipalName。

请求头

名称	必需	类型	说明
Authorization	True	string	授权持有者令牌
Accept	True	string	可接受的内容类型;广泛加入类型应用程序/json
ms-correlationid		string	用于在内部跟踪请求。 如果未提供 ms-correlationid，则服务器将为每个请求生成一个新请求
ms-requestid		string	用于请求的幂等性。 如果未提供 ms-requestid，服务器将为每个请求生成一个新请求

响应

名称	类型	说明
200 OK	Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]	请求成功。 响应正文包含用户成员列表。 Media Types: "application/json", "text/json"
400 Bad Request		输入缺失或无效。 响应正文将提供错误详细信息。 Media Types: "application/json", "text/json"
401 Unauthorized		请求未通过身份验证。 客户端需要首先通过合作伙伴 API 服务进行身份验证。 Media Types: "application/json", "text/json"
403 Forbidden		请求已经过身份验证，但被拒绝，因为调用方无权调用该请求。 Media Types: "application/json", "text/json"
404 Not Found		找不到资源或未与给定输入参数一起使用。 Media Types: "application/json", "text/json"
500 Internal Server Error		合作伙伴 API 服务或其某个依赖项未能满足请求。 调用方可能会重试此操作。 Media Types: "application/json", "text/json"

定义

名称	说明
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]	包含包含 JSON 属性的资源集合，用于表示输出
Microsoft.Partner.Sdk.Contracts.V1.Common.Link	链接表示 URI 和 HTTP 方法，该方法指示访问资源所需的操作。
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	引用通用对象属性
Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	资源的导航链接
Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember	描述用户的成员信息。
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]

包含包含 JSON 属性的资源集合，用于表示输出

名称	类型	说明
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	获取属性。
items	Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember[]	获取集合项。
links	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks	获取或设置链接。
totalCount	integer	获取总计计数。

Microsoft.Partner.Sdk.Contracts.V1.Common.Link

链接表示 URI 和 HTTP 方法，该方法指示访问资源所需的操作。

名称	类型	说明
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]	获取链接标头。
method	string	方法。
uri	string	URI。

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes

引用通用对象属性

名称	类型	说明
etag	string	获取或设置 etag。 提供程序中的对象版本。
objectType	string	对象的类型。

Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceLinks

资源的导航链接

名称	类型	说明
next	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	项的下一页。
previous	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	项的上一页。
self	Microsoft.Partner.Sdk.Contracts.V1.Common.Link	自 URI。

Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember

描述用户的成员信息。

名称	类型	说明
accountId	string	获取或设置角色分配绑定的帐户 ID。
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	获取属性。
displayName	string	获取或设置用户的显示名称。
id	string	成员的标识符。
roleId	string	用户角色的标识符。
userPrincipalName	string	获取或设置用户主体的名称。

System.Collections.Generic.KeyValuePair[System.String,System.String]

名称	类型	说明
key	string
value	string