特定のサービスプロバイダーの設定の取得
最終更新日: 2025年3月5日
- トピック:
- 認証
このページのコンテンツは情報提供のみを目的としています。 この API を使用するには、Adobeの最新ライセンスが必要です。 無許可の使用は許可されていません。
REST API V2 の実装については、 スロットルメカニズムのドキュメントで制限されています。
Related Articles
また、REST API V2 の FAQ も必ず参照してください。
リクエスト
HTTP
パス
/api/v2/{serviceProvider}/configuration
メソッド
GET
パスパラメーター
serviceProvider
オンボーディングプロセス中にサービスプロバイダーに関連付けられた内部の一意の ID。
必須
クエリパラメーター
profile
-
optional
ヘッダー
X-Device-Info
デバイス情報ペイロードの生成については、X-Device-Info ヘッダーのドキュメントを参照してください。
アプリケーションのデバイスプラットフォームで有効な値を明示的に指定できる場合は、常に使用することを強くお勧めします。
指定した場合、Adobe Pass認証バックエンドは、明示的に設定された値を、抽出された値と暗黙的に(デフォルトで)結合します。
指定しない場合、Adobe Pass認証バックエンドでは、抽出された値が暗黙的に(デフォルトで)使用されます。
アプリケーションのデバイスプラットフォームで有効な値を明示的に指定できる場合は、常に使用することを強くお勧めします。
指定した場合、Adobe Pass認証バックエンドは、明示的に設定された値を、抽出された値と暗黙的に(デフォルトで)結合します。
指定しない場合、Adobe Pass認証バックエンドでは、抽出された値が暗黙的に(デフォルトで)使用されます。
必須
X-Forwarded-For
ストリーミングデバイスの IP アドレス。
サーバーからサーバーへの実装には常に使用することを強くお勧めします。特に、呼び出しがストリーミングデバイスではなくプログラマーサービスによって行われる場合に強くお勧めします。
クライアントからサーバーへの実装の場合、ストリーミングデバイスの IP アドレスは暗黙的に送信されます。
サーバーからサーバーへの実装には常に使用することを強くお勧めします。特に、呼び出しがストリーミングデバイスではなくプログラマーサービスによって行われる場合に強くお勧めします。
クライアントからサーバーへの実装の場合、ストリーミングデバイスの IP アドレスは暗黙的に送信されます。
optional
承諾
クライアントアプリケーションによって受け入れられるメディアタイプ。
指定する場合は、application/json にする必要があります。
指定する場合は、application/json にする必要があります。
optional
User-Agent
クライアントアプリケーションのユーザーエージェント。
optional
応答
成功
ヘッダー
ステータス
200
必須
Content-Type
application/json
必須
本文
要素のリストを含む JSON。各要素は次の属性を持ちます。
属性
デバイス
デバイスタイプ
必須
clientType
クライアントタイプ
errorReporting
オブジェクト
要求者
次の属性を持つ JSON オブジェクト。
- id
オンボーディングプロセス中にサービスプロバイダーに関連付けられた一意の内部識別子。 - name
オンボーディングプロセス中にサービスプロバイダーに関連付けられた商用(ブランド)名。 - domains
サービスプロバイダーを表すためにAdobe Pass Authentication にリストされるドメイン名のリスト。
必須
mvpds
次の属性を持つ JSON オブジェクト。
- id
オンボーディングプロセス中に ID プロバイダーに関連付けられた一意の内部識別子。 - displayName
オンボーディングプロセス中に ID プロバイダーに関連付けられた商用(ブランド)名。 - logoUrl
ID プロバイダーに関連付けられたロゴのダウンロード元の URL です。 - isTempPass
MVPDが TempPass 機能を提供するように設計されているかどうかを指定するフラグ。 - isProxy
MVPDがプロキシ化されたMVPDかどうかを指定するフラグ。 - boardingStatus
シングルサインオンフローで、ID プロバイダーがストリーミングデバイスプラットフォームによってオンボードされるかどうかを指定するステータス。 - platformMappingId
シングルサインオンフロー用のストリーミングデバイスプラットフォームによって ID プロバイダーに関連付けられた内部の一意の ID。 - enablePlatformServices
シングルサインオンフローのストリーミングデバイスプラットフォームに対して ID プロバイダー設定が有効かどうかを指定するフラグ。 - displayInPlatformPicker
シングルサインオンフローで ID プロバイダーをストリーミングデバイスプラットフォームピッカーに表示できるかどうかを指定するフラグ。 - enforcePlatformPermissions
シングルサインオンフロー用にプラットフォームで提供されるユーザー権限をストリーミングデバイスで適用する必要があるかどうかを指定するフラグ。
必須
time
必須
必須
エラー
ヘッダー
ステータス
400、401、405、500
必須
Content-Type
application/json
必須
本文
応答本文には、 拡張エラーコードドキュメントに従った追加のエラー情報が提供される場合があります。
必須
サンプル
1.特定のサービスプロバイダーの設定を取得する
リクエスト
GET /api/v2/REF30/configuration/ HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
Accept: application/json
User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
応答
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"device": "unknown",
"clientType": "html5",
"os": "Unknown",
"requestor": {
"id": "REF30",
"name": "Reference site only in 30",
"domains": [
{
"name": "adobe.com",
"mvpdInitiated": false
},
{
"name": "adobe.io",
"mvpdInitiated": false
},
{
"name": "adobepass.com",
"mvpdInitiated": false
},
{
"name": "adobeptime.com",
"mvpdInitiated": false
},
{
"name": "anvilcreative.com",
"mvpdInitiated": false
},
{
"name": "testadobe.com",
"mvpdInitiated": false
}
],
"mvpds": [
{
"id": "AdobePass_SMI",
"displayName": "Adobe Pass SMI",
"logoUrl": "https://blogs.adobe.com/conversations/files/2010/08/adobe-logo.jpg",
"authPerAggregator": false
},
{
"id": "TempPass_TEST40",
"displayName": "Adobe Temp Pass Test 3 min",
"logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
"authPerAggregator": true,
"isTempPass": true
},
{
"id": "TempPass_TEST44",
"displayName": "Adobe Temp Pass Test 30 min",
"logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
"authPerAggregator": true,
"isTempPass": true
},
{
"id": "AdobeShibboleth",
"displayName": "AdobeShibboleth",
"logoUrl": "https://entitlement.auth.adobe.com/entitlement/adobe.png"
},
{
"id": "ATTOTT",
"displayName": "DIRECTV STREAM",
"logoUrl": "https://entitlement.auth.adobe.com/entitlement/directvstream.jpg"
},
{
"id": "ElasticSSO",
"displayName": "ElasticSSO",
"logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
"authPerAggregator": false
},
{
"id": "TempPass",
"displayName": "Temp-Pass",
"logoUrl": "https://entitlement.auth.adobe.com/entitlement/noLogo.png",
"passiveAuthnEnabled": false,
"authPerAggregator": true,
"isTempPass": true
},
{
"id": "Comcast_SSO_Perf",
"displayName": "Xfinity Perf",
"logoUrl": "https://login.comcast.net/static/images/ci/tve/mvpd_comcast_logo112x33.gif",
"authPerAggregator": true,
"authPerBrowserSession": true
}
]
}
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b