顧客のユーザー ロールを取得するGet user roles for a customer

適用対象Applies To

  • パートナー センターPartner Center

ユーザーアカウントにアタッチされているすべてのロール/アクセス許可の一覧を取得します。Get a list of all the roles/permissions attached to a user account. バリエーションには、顧客のすべてのユーザーアカウントのすべてのアクセス許可の一覧を取得し、特定のロールを持つユーザーの一覧を取得することが含まれます。Variations include getting a list of all permissions across all user accounts for a customer, and getting a list of users that have a given role.

前提条件Prerequisites

  • パートナー センターの認証に関するページで説明している資格情報。Credentials as described in Partner Center authentication. このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。This scenario supports authentication with App+User credentials only.

  • 顧客 ID です (customer-tenant-id)。A customer ID (customer-tenant-id). お客様の ID がわからない場合は、パートナー センターのダッシュボードで検索できます。If you don't know the customer's ID, you can look it up in the Partner Center dashboard. パートナー センター メニューの [CSP] を選択し、 [顧客] を選択します。Select CSP from the Partner Center menu, followed by Customers. 顧客一覧からお客様を選び、 [アカウント] を選択します。Select the customer from the customer list, then select Account. お客様のアカウント ページで、 [顧客のアカウント情報] セクションの Microsoft ID を探します。On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。The Microsoft ID is the same as the customer ID (customer-tenant-id).

C#C#

指定された顧客のすべてのディレクトリロールを取得するには、最初に指定された顧客 ID を取得します。To retrieve all the directory roles for a specified customer, first retrieve the specified customer ID. 次に、 iaggregatepartner.customersコレクションを使用して、 ById () メソッドを呼び出します。Then, use your IAggregatePartner.Customers collection and call the ById() method. 次に、 Directoryrolesプロパティを呼び出し、その後にGet () またはGetAsync () メソッドを呼び出します。Then call the DirectoryRoles property, followed by the Get() or GetAsync() method.

// string selectedCustomerId;
// IAggregatePartner partnerOperations;

var directoryRoles = partnerOperations.Customers.ById(selectedCustomerId).DirectoryRoles.Get();

サンプル:コンソールテストアプリSample: Console test app. プロジェクト: パートナーセンター SDK サンプルクラス: GetCustomerDirectoryRoles.csProject: Partner Center SDK Samples Class: GetCustomerDirectoryRoles.cs

特定のロールを持つ顧客ユーザーの一覧を取得するには、まず、指定された顧客 ID とディレクトリロール ID を取得します。To retrieve a list of customer users that have a given role, first retrieve the specified customer ID and the directory role ID. 次に、 iaggregatepartner.customersコレクションを使用して、 ById () メソッドを呼び出します。Then, use your IAggregatePartner.Customers collection and call the ById() method. 次に、 Directoryrolesプロパティ、 ById () メソッド、 usermembersプロパティ、およびその後にGet () またはGetAsync () メソッドを呼び出します。Then call the DirectoryRoles property, then ById() method, then the UserMembers property, the followed by the Get() or GetAsync() method.

// string selectedCustomerId;
// IAggregatePartner partnerOperations;
// string selectedDirectoryRoleId;

var userMembers = partnerOperations.Customers.ById(selectedCustomerId).DirectoryRoles.ById(selectedDirectoryRoleId).UserMembers.Get();

サンプル:コンソールテストアプリSample: Console test app. プロジェクト: partnersdk. FeatureSamplesクラス: GetCustomerDirectoryRoleUserMembers.csProject: PartnerSDK.FeatureSamples Class: GetCustomerDirectoryRoleUserMembers.cs

REST 要求REST request

要求の構文Request syntax

認証方法Method 要求 URIRequest URI
GETGET {baseURL}/v1/customers/{customer-tenant-id}/users/{user-id}/directoryroles HTTP/1.1{baseURL}/v1/customers/{customer-tenant-id}/users/{user-id}/directoryroles HTTP/1.1
GETGET {baseURL}/v1/customers/{customer-tenant-id}/directoryroles HTTP/1.1{baseURL}/v1/customers/{customer-tenant-id}/directoryroles HTTP/1.1
GETGET {baseURL}/v1/customers/{customer-tenant-id}/directoryroles/{role-ID}/usermembers{baseURL}/v1/customers/{customer-tenant-id}/directoryroles/{role-ID}/usermembers

URI パラメーターURI parameter

次のクエリパラメーターを使用して、正しい顧客を特定します。Use the following query parameter to identify the correct customer.

名前Name TypeType 必須Required 説明Description
customer-tenant-idcustomer-tenant-id guidguid YY この値は、リセラーがリセラーに属する特定の顧客の結果をフィルター処理できるようにする GUID 形式の顧客テナント idです。The value is a GUID formatted customer-tenant-id that allows the reseller to filter the results for a given customer that belongs to the reseller.
ユーザー iduser-id guidguid NN 値は、1つのユーザーアカウントに属する GUID 形式のユーザー idです。The value is a GUID formatted user-id that belongs to a single user account.
ロール idrole-id guidguid NN 値は、ロールの種類に属する GUID 形式のロール idです。The value is a GUID formatted role-id that belongs to a type of role. すべてのユーザー アカウントを対象に、ある顧客のすべてのディレクトリ ロールを問い合わせることで、これらの ID を取得できます。You can get these IDs by querying all the directory roles for a customer, across all user accounts. (上記の2番目のシナリオ)。(The second scenario, above).

要求ヘッダーRequest headers

詳細については、「パートナー センター REST ヘッダー」を参照してください。For more information, see Partner Center REST headers.

[要求本文]Request body

要求の例Request example

GET https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/users/<user-id>/directoryroles HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: b1317092-f087-471e-a637-f66523b2b94c
MS-CorrelationId: 8a53b025-d5be-4d98-ab20-229d1813de76

REST 応答REST response

成功した場合、このメソッドは、指定されたユーザーアカウントに関連付けられているロールの一覧を返します。If successful, this method returns a list of the roles associated with the given user account.

応答の成功とエラーのコードResponse success and error codes

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。Each response comes with an HTTP status code that indicates success or failure and additional debugging information. このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。Use a network trace tool to read this code, error type, and additional parameters. 完全な一覧については、エラー コードに関するページを参照してください。For the full list, see Error Codes.

応答の例Response example

HTTP/1.1 200 OK
Content-Length: 31942
Content-Type: application/json
MS-CorrelationId: 8a53b025-d5be-4d98-ab20-229d1813de76
MS-RequestId: b1317092-f087-471e-a637-f66523b2b94c
Date: June 24 2016 22:00:25 PST

{
      "totalCount": 2,
      "items": [
        {
          "name": "Helpdesk Administrator",
          "id": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
          "attributes": { "objectType": "DirectoryRole" }
        },
        {
          "name": "User Account Administrator",
          "id": "fe930be7-5e62-47db-91af-98c3a49a38b1",
          "attributes": { "objectType": "DirectoryRole" }
        }
      ],
      "attributes": { "objectType": "Collection" }
}