Manage account profiles - Get user members by role

Service:

Partner Center Rest

API Version:

v1

取得角色使用者成員的區段，其上限為特定大小。

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
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。

要求標頭

名稱	必要	類型	Description
Authorization	True	string	授權持有人權杖
Accept	True	string	可接受的內容類型;廣泛累算類型 application/json
ms-correlationid		string	用於在內部追蹤要求。 如果未提供 ms-correlationid，伺服器將會為每個要求產生新的識別碼
ms-requestid		string	用於要求的等冪性。 如果未提供 ms-requestid，伺服器將會為每個要求產生新的要求

回應

名稱	類型	Description
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"

定義

名稱	Description
Microsoft.Partner.Sdk.Contracts.V1.Collections.ResourceCollection[Microsoft.Partner.Sdk.Contracts.V1.Contracts.RoleManagement.UserMember]	包含具有 JSON 屬性的資源集合，以表示輸出
Microsoft.Partner.Sdk.Contracts.V1.Common.Link	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 屬性的資源集合，以表示輸出

名稱	類型	Description
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

Link 代表 URI 和 HTTP 方法，表示存取資源所需的動作。

名稱	類型	Description
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]	取得連結標頭。
method	string	方法。
uri	string	URI。

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

參考通用物件屬性

名稱	類型	Description
etag	string	取得或設定 etag。 提供者中的物件版本。
objectType	string	物件的型別。

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

資源的導覽連結

名稱	類型	Description
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

描述使用者的成員資訊。

名稱	類型	Description
accountId	string	取得或設定系結角色指派的帳戶識別碼。
attributes	Microsoft.Partner.Sdk.Contracts.V1.Common.ResourceAttributes	取得屬性。
displayName	string	取得或設定使用者的顯示名稱。
id	string	成員的識別碼。
roleId	string	使用者角色的識別碼。
userPrincipalName	string	取得或設定使用者主體的名稱。

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

名稱	類型	Description
key	string
value	string