擷取特定服務提供者的設定

最後更新： 2025年3月5日

主題：
驗證

重要

此頁面上的內容僅供參考。使用此API需要Adobe的目前授權。不允許未經授權的使用。

重要

REST API V2實作受到節流機制檔案的限制。

請求

HTTP

路徑

/api/v2/{serviceProvider}/configuration

方法

GET

路徑引數

服務提供者

在上線流程中與服務提供者相關聯的內部唯一識別碼。

必填

查詢參數

設定檔

-

可選

標頭

Authorization

在授權標標頭檔案中說明了持有人權杖承載的產生。

必填

AP-Device-Identifier

在AP-Device-Identifier標標頭檔案中說明裝置識別碼裝載的產生。

必填

X-Device-Info

在X-Device-Info標題檔案中會說明裝置資訊承載的產生。

強烈建議您在應用程式的裝置平台允許明確提供有效值時，一律使用此值。

提供此屬性時，Adobe Pass驗證後端會以隱含方式將明確設定的值與擷取的值合併（預設為）。

若未提供，Adobe Pass驗證後端將會以隱含方式使用擷取的值（依預設）。

必填

X-Forwarded-For

串流裝置的IP位址。

強烈建議一律將它用於伺服器對伺服器的實作，尤其是當呼叫是由程式設計人員服務（而非串流裝置）進行時。

對於使用者端對伺服器實作，會以隱含方式傳送串流裝置的IP位址。

可選

Accept

使用者端應用程式接受的媒體型別。

若指定，則必須是application/json。

可選

User-Agent

使用者端應用程式的使用者代理。

可選

回應

程式碼

文字

說明

200

確定

回應本文包含與「serviceProvider」具有有效整合的MVPD清單。

400

錯誤請求

請求無效，使用者端需要修正請求，然後再試一次。回應本文可能包含遵守增強錯誤碼檔案的錯誤資訊。

401

未獲授權

存取權杖無效，使用者端需要取得新的存取權杖並重試。如需詳細資訊，請參閱動態使用者端註冊概觀檔案。

405

不允許的方法

HTTP方法無效，使用者端需要使用請求資源所允許的HTTP方法，然後再試一次。如需詳細資訊，請參閱要求區段。

500

內部伺服器錯誤

伺服器端發生問題。回應本文可能包含遵守增強錯誤碼檔案的錯誤資訊。

成功

標頭

狀態

200

必填

Content-Type

application/json

必填

內文

JSON包含元素清單，每個元素都具有下列屬性：

屬性

裝置

裝置型別

必填

clientType

使用者端型別

errorReporting

物件

要求者

具有以下屬性的JSON物件：

id
上線程式期間與服務提供者相關聯的內部唯一識別碼。
名稱
上線程式期間與服務提供者相關聯的商業（品牌）名稱。
網域
列在Adobe Pass驗證中代表服務提供者的網域名稱清單。

必填

mvpds

具有以下屬性的JSON物件：

id
上線程式期間與身分提供者相關聯的內部唯一識別碼。
displayName
上線程式期間與身分提供者相關聯的商業（品牌）名稱。
logoUrl
下載與身分提供者相關聯標誌的URL。
isTempPass
指定MVPD是否設計提供TempPass功能功能的旗標。
isProxy
指定MVPD是否為代理的MVPD的旗標。
boardingStatus
指定識別提供者是否由串流裝置平台登入以進行單一登入流程的狀態。
platformMappingId
串流裝置平台與身分提供者相關聯的內部唯一識別碼，適用於單一登入流程。
enablePlatformServices
指定是否針對單一登入流程為串流裝置平台啟用識別提供者設定的旗標。
displayInPlatformPicker
指定是否可將身分提供者顯示在串流裝置平台選擇器中，以進行單一登入流程的旗標。
enforcePlatformPermissions
指定串流裝置是否必須強制平台所提供的使用者許可權以供單一登入流程使用的旗標。

必填

時間

必填

錯誤

標頭

狀態

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