使用合作夥伴驗證回應建立和擷取設定檔

最後更新： 2025年7月10日

主題：
驗證

重要

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

重要

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

請求

HTTP

路徑

/api/v2/{serviceProvider}/profiles/sso/{partner}

方法

POST

路徑引數

服務提供者

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

必填

合作夥伴

提供與Adobe Pass驗證流程整合的單一登入架構的合作夥伴名稱(例如Apple)。

必填

主體引數

SAMLResponse

合作夥伴驗證回應，包含建立和儲存合作夥伴設定檔所需的使用者中繼資料。

值必須是Base64編碼和之後的URL編碼。

必填

標頭

Authorization

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

必填

Content-Type

所傳送資源的接受媒體型別。

它必須是application/x-www-form-urlencoded。

必填

AP-Device-Identifier

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

必填

X-Device-Info

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

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

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

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

必填

AP-Partner-Framework-Status

在AP-Partner-Framework-Status標標頭檔案中會說明Partner方法單一登入裝載的產生方式。

如需有關使用合作夥伴啟用單一登入流程的詳細資訊，請參閱使用合作夥伴的單一登入流程檔案。

可選

X-Forwarded-For

串流裝置的IP位址。

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

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

可選

Accept

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

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

可選

User-Agent

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

可選

回應

程式碼

文字

說明

201

已建立

回應本文包含有效設定檔的地圖，該地圖可能為空白。

400

錯誤請求

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

401

未獲授權

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

405

不允許的方法

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

500

內部伺服器錯誤

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

成功

標頭

狀態

201

必填

Content-Type

application/json

必填

內文

設定檔

JSON包含索引鍵、值配對的對應。

索引鍵元素由下列值定義：

值

mvpd

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

必填

值元素由下列屬性定義：

屬性

notBefore

設定檔無效之前的時間戳記（以毫秒為單位）。

必填

notAfter

設定檔無效的時間戳記（以毫秒為單位）。

必填

簽發者

擁有設定檔的實體。

可能的值包括：

Apple
建立設定檔的原因為：使用合作夥伴Apple的單一登入。

必填

type

設定檔的型別。

可能的值包括：

appleSSO
建立設定檔的原因為：使用合作夥伴Apple的單一登入。

必填

屬性

JSON包含索引鍵、值配對的對應。

關鍵元素由使用者中繼資料屬性定義，可以是：

強制性，例如「userID」
非強制性，例如「zip」、「householdID」、「maxRating」等。

屬性的值可以是：

簡單
清單
地圖

驗證流程完成後，使用者中繼資料即可使用，但在授權流程期間，某些中繼資料屬性可能會更新，具體取決於MVPD和有問題的特定中繼資料屬性。

必填

錯誤

標頭

狀態

400， 401， 405， 500

必填

Content-Type

application/json

必填

內文

回應內文可能會提供其他錯誤資訊，這些資訊會遵守增強型錯誤碼檔案。

必填

範例

1.使用合作夥伴驗證回應來建立和擷取設定檔

要求

POST /api/v2/REF30/profiles/sso/Apple HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAiYWNjZXNzU3RhdHVzIjogImdyYW50ZWQiCiAgICB9LAogICAgImZyYW1ld29ya1Byb3ZpZGVySW5mbyIgOiB7CiAgICAgICJpZCIgOiAiQ2FibGV2aXNpb24iLAogICAgICAiZXhwaXJhdGlvbkRhdGUiIDogIjIwMjU0MzA2MzYwMDAiCiAgICB9Cn0=
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

SAMLResponse=PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIH...

回應

HTTP/1.1 201 Created

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1752149281000,
            "notAfter": 1783685280000,
            "issuer": "Apple",
            "type": "appleSSO",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                },
                "householdID": {
                    "value": "BASE64_value_householdId",
                    "state": "plain"
                },
                "zip": {
                    "value": "BASE64_value_zip",
                    "state": "enc"
                }
            }
        }
     }
}

2.使用合作夥伴驗證回應來建立和擷取設定檔，但套用效能降低

要求

POST /api/v2/REF30/profiles/sso/Apple HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    AP-Partner-Framework-Status: ewogICAgImZyYW1ld29ya1Blcm1pc3Npb25JbmZvIjogewogICAgICAiYWNjZXNzU3RhdHVzIjogImdyYW50ZWQiCiAgICB9LAogICAgImZyYW1ld29ya1Byb3ZpZGVySW5mbyIgOiB7CiAgICAgICJpZCIgOiAiJHtkZWdyYWRlZE12cGR9IiwKICAgICAgImV4cGlyYXRpb25EYXRlIiA6ICIyMDI1NDMwNjM2MDAwIgogICAgfQp9
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

SAMLResponse=PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIH...

回應

HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "${degradedMvpd}": {
            "notBefore": 1706636062704,
            "notAfter": 1706696062704,
            "issuer": "Adobe",
            "type": "degraded",
            "attributes": {
                "userID": {
                    "value": "95cf93bcd183214ac9e4433153cb8a9d180a463128c0a5d26f202e8c",
                    "state": "plain"
                }
            }
        }
   }
}

recommendation-more-help