パートナーの代理管理者の顧客を一覧表示する
適用対象: パートナー センター
パートナーのすべての顧客の一覧を返します。また、顧客が DAP/DAP 以外の関係を持っているかどうかを示します。
目的: パートナーは、顧客と DAP 関係を削除する - パートナー センター アプリ開発者を使用して、顧客テナントを安全に管理し、90 日を超える非アクティブな DAP リレーションシップを削除するために準拠しています。
Note
この API は有効期間が短く、DAP 廃止フェーズ中にサポートされます。 DAP 非推奨プログラムを投稿すると、この API は廃止されます。
前提条件
資格情報
このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。
アクセス トークンを受信するためのトークン交換
詳細については、「Web API にアクセスするようにアプリを構成する」を参照してください。
PowerShell コンソールから次のコマンドを実行して、パートナー テナントでパートナー 顧客委任管理istration API アプリのサービス プリンシパルを作成します。
Microsoft Entra ID に接続します。
Connect-MgGraph対話型ウィンドウを開いてサインインします。 サンドボックス パートナー テナントの資格情報を入力します。
次に、新しいサービス プリンシパルを作成します。
New-MgServicePrincipal -AppId 2832473f-ec63-45fb-976f-5d45a7d4bb91ObjectId AppId 表示名 c1bf31da-09e5-4985-ab50-3232d4ae4f5a 2832473f-ec63-45fb-976f-5d45a7d4bb91 パートナー顧客の委任された管理参加 次に、Azure portal に移動し、アプリの登録し、パブリック クライアント アプリを作成するか、既存のアプリを使用して、テナントにアプリを作成します。
[API のアクセス許可>の表示] を選択します。組織が使用するアクセス許可>API を追加する
パートナー顧客の委任された管理委任>されたアクセス許可の追加アクセス許可>の選択
この新しいアクセス許可に対して管理者の同意を付与します。
このアプリ (ログインしたテナント管理者) を使用して、(リソース https://api.partnercustomeradministration.microsoft.comを含む) App+User トークンを使用して GDAP API を呼び出すようになりました。
POST https://login.microsoftonline.com/<partner_tenant_id>/oauth2/token grant_type=client_credentials&scope:https://api.partnercustomeradministration.microsoft.com&client_id:<client_id>&client_secret:<client_secret>
REST 要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | https://traf-pcsvcadmin-prod.trafficmanager.net/CustomerServiceAdminApi/Web/v1/delegatedAdminCustomers |
URI パラメーター
この API には URI パラメーターは必要ありません。
要求ヘッダー
| ヘッダー | 説明 | Value |
|---|---|---|
| 承認 | ベアラー <token>形式の承認トークン。 |
String |
要求本文
この API の要求本文は指定しないでください。
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに$select役立つ 、、$filter、 $skip$top$countおよび $orderBy (許可されるフィールド: organizationDisplayName、dapEnabled、startDateTime、lastSignInDateTime) をサポートします。
$top では、最大 300 個のオブジェクトがサポートされます。
要求の例
GET https://traf-pcsvcadmin-prod.trafficmanager.net/CustomerServiceAdminApi/Web/v1/delegatedAdminCustomers
HTTP/1.1
Authorization: Bearer \<token\>
Content-Type: application/json; charset=utf-8
REST 応答
成功した場合、このメソッドは、応答本文で委任された管理Customers リソースのコレクションを返します。
応答の成功とエラーのコード
各応答には、成功または失敗とその他のデバッグ情報を示す HTTP 状態コードが付属しています。 ネットワーク トレース ツールを使用して、このコード、エラーの種類、およびその他のパラメーターを読み取ります。 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。
delegated管理Customers リソース
パートナーの代理管理者の顧客と、顧客のテナントへのパートナーのアクセスに関する詳細を表します。
Properties
| プロパティ | タイプ | 説明 |
|---|---|---|
| id | String | 顧客テナントの一意識別子。 |
| customerTenantId | String | 顧客テナントの一意識別子。 |
| OrganizationDisplayName | String | 顧客の組織の表示名。 |
| partnerAgentCount | int | 過去 1 日に顧客テナントにサインインしたパートナーの数。 |
| partnerSignInCount | int | パートナーが過去 1 日に顧客テナントにサインインした回数。 |
| dapEnabled | Boolean | この値は、パートナーが顧客の DAP 関係を持っているかどうかを示します。 False の場合: その顧客に対して DAP リレーションシップが存在しません。 True の場合: その顧客に対して DAP リレーションシップが存在する |
| startDateTime | String | DAP リレーションシップが確立された日時。 |
| endDateTime | String | DAP リレーションシップの日時が終了しました。 |
| lastSignInDateTime | String | パートナーがこの顧客テナントにサインインした最後の日時。Null/empty: パートナーによる顧客テナントへのサインインはありません。 |
応答の例
{
"@odata.context": "https://traf-pcsvcadmin-prod.trafficmanager.net/CustomerServiceAdminApi/Web/v1/$metadata#delegatedAdminCustomers",
"value": [
{
"id": "53018d99-ac51-4ec8-b86e-c8a61de43717",
"customerTenantId": "53018d99-ac51-4ec8-b86e-c8a61de43717",
"organizationDisplayName": "Test_Test_GAA_Partner_Account",
"partnerAgentCount": 0,
"partnerSignInCount": 0,
"globalAdminSignInCount": 0,
"dapEnabled": false,
"startDateTime": "2021-08-06T21:15:04.3461507Z",
"endDateTime": null,
"lastSignInDateTime": null
},
{
"id": "6fc468f5-b399-4e05-a6f1-da8a33da9a6c",
"customerTenantId": "6fc468f5-b399-4e05-a6f1-da8a33da9a6c",
"organizationDisplayName": "StagingTest",
"partnerAgentCount": 0,
"partnerSignInCount": 0,
"globalAdminSignInCount": 0,
"dapEnabled": true,
"startDateTime": "2022-04-20T06:11:11.7227953Z",
"endDateTime": null,
"lastSignInDateTime": "2022-04-20T06:11:11.7227953Z"
}
]
}
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示