次の方法で共有

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

並べ替えの方向のオプションの並べ替えパラメーター。指定できる値は昇順と降順で、既定値は Ascending です
sortField
 query

string

並べ替えの基準となるフィールドのオプションの並べ替えパラメーター。指定できる値は DisplayName と UserPrincipalName で、既定値は UserPrincipalName です。

要求ヘッダー

名前 必須 型 説明
Authorization True

string

承認ベアラー トークン
Accept True

string

受け入れ可能なコンテンツ タイプ。広くアクセスされた型の application/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 サービスまたはその依存関係の 1 つが要求を満たできませんでした。 呼び出し元はこれを再試行できます。

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

合計カウントを取得します。

リンクは、リソースにアクセスするための必要なアクションを示す 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

オブジェクトの型。

リソースのナビゲーション リンク

名前 型 説明
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