建立驗證工作階段 create-authentication-session

最後更新： 2026年7月7日

主題：
Authentication

IMPORTANT

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

IMPORTANT

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

請求 request

HTTP

路徑

/api/v2/{serviceProvider}/sessions

方法

POST

路徑引數

服務提供者

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

必填

主體引數

mvpd

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

如果串流裝置平台在提供值方面有所限制，則應用程式必須繼續驗證工作階段並提供有效值。

必填

domainName

執行MVPD登入之應用程式的原始網域。

如果串流裝置平台在提供值方面有所限制，則應用程式必須繼續驗證工作階段並提供有效值。

必填

redirectUrl

MVPD驗證流程完成後，使用者代理程式導覽的最終重新導向URL。

值必須以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驗證後端將會以隱含方式使用擷取的值（依預設）。

必填

X-Forwarded-For

串流裝置的IP位址。

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

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

可選

Adobe-Subject-Token
或
X-Roku-Reserved-Roku-Connect-Token

有關Platform Identity方法單一登入裝載的產生，請參閱Adobe-Subject-Token / X-Roku-Reserved-Roku-Connect-Token標標頭檔案。

如需使用平台身分識別啟用單一登入流程的詳細資訊，請參閱使用平台身分識別流程單一登入檔案。

可選

AD-Service-Token

服務權杖方法的單一登入裝載產生過程在AD-Service-Token標標頭檔案中進行了說明。

如需使用服務權杖啟用單一登入流程的詳細資訊，請參閱使用服務權杖流程進行單一登入檔案。

可選

AP-Visitor-Identifier

AP-Visitor-Identifier標標頭檔案中會說明產生訪客識別碼承載的流程。

可選

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

若指定，則必須為application/json；charset=utf-8。

可選

User-Agent

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

可選

回應 response

程式碼

文字

說明

200

確定

回應內文包含執行驗證所需後續動作的資訊。

400

錯誤請求

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

401

未獲授權

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

405

不允許的方法

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

500

內部伺服器錯誤

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

成功 success

標頭

狀態

200

必填

Content-Type

application/json

必填

內文

具有以下屬性的JSON物件：

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 1-bgcolor-#eff2f7 2-bgcolor-#eff2f7 3-bgcolor-#eff2f7 5-bgcolor-#deebff 9-bgcolor-#deebff 13-bgcolor-#deebff 17-bgcolor-#deebff 21-bgcolor-#deebff 25-bgcolor-#deebff 29-bgcolor-#deebff 33-bgcolor-#deebff 37-bgcolor-#deebff 41-bgcolor-#deebff 45-bgcolor-#deebff layout-auto html-authored
屬性
actionName	串流裝置完成驗證流程所需執行的動作。可能的值包括：驗證串流裝置或其他裝置需要在使用者代理程式中開啟提供的URL。繼續串流裝置或其他裝置需要提供遺漏的引數，並使用程式碼繼續驗證工作階段。授權串流裝置可以直接進行決定流程。	必填
actionType	串流裝置必須執行的互動型別，才能使用「actionName」屬性所指定的動作繼續流程。可能的值包括：互動式流程繼續使用使用者代理程式導覽至提供的URL。直接流程會繼續使用使用者端實作可用的HTTP使用者端直接呼叫提供的URL。	必填
reasonType	說明「actionName」的原因型別。可能的值包括：無使用者端應用程式必須繼續驗證。已驗證使用者端應用程式已透過基本存取流程驗證。暫時使用者端應用程式已透過暫存存取流程驗證。已降級使用者端應用程式已透過已降級的存取流程進行驗證。 authenticatedSSO 使用者端應用程式已透過單一登入存取流程驗證。	必填
missingParameters	需要提供遺失的引數，才能完成基本驗證流程。	可選
url	使用者端應用程式需要導覽的URL。	可選
程式碼	可用於次要應用程式的驗證代碼，以繼續驗證工作階段。	可選
sessionId	可用於追蹤使用者活動的不透明識別碼。	必填
mvpd	上線流程中與身分提供者相關聯的內部唯一識別碼。	可選
服務提供者	在上線流程中與服務提供者相關聯的內部唯一識別碼。	必填
notBefore	驗證程式碼無效之前的時間戳記（以毫秒為單位）。	可選
notAfter	驗證代碼無效的時間戳記（以毫秒為單位）。	可選

必填

錯誤 error

標頭

狀態

400, 401, 405, 500

必填

Content-Type

application/json

必填

內文

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

必填

範例 samples

1. 建立驗證工作階段，但不遺失引數

要求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com

回應

code language-https

HTTP/1.1 200 OK

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

{
    "actionName": "authenticate",
    "actionType": "interactive",
    "reasonType": "none",
    "url": "/api/v2/authenticate/REF30/8ER640M",
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30",
    "notBefore": "1733735289035",
    "notAfter": "1733737089035"
}

2. 建立缺少引數的驗證工作階段

要求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

回應

code language-https

HTTP/1.1 200 OK

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

{
    "actionName": "resume",
    "actionType": "direct",
    "reasonType": "none",
    "url": "/api/v2/REF30/sessions/8ER640M",
    "missingParameters": ["mvpd", "domain", "redirectUrl"],
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "serviceProvider": "REF30",
    "notBefore": "1733735289035",
    "notAfter": "1733737089035"
}

3. 當有效的設定檔已存在時，建立驗證工作階段

要求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com

回應

code language-https

HTTP/1.1 200 OK

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

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "authenticated",
    "url": "/api/v2/REF30/decisions/authorize/Cablevision",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}

4. 使用基本或促銷臨時傳遞建立驗證工作階段（不需要）

要求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=TempPass_TEST40&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com

回應

code language-https

HTTP/1.1 200 OK

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

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "temporary",
    "url": "/api/v2/REF30/decisions/authorize/TempPass_TEST40",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "TempPass_TEST40",
    "serviceProvider": "REF30"
}

5. 套用降級時建立驗證工作階段

要求

code language-https

POST /api/v2/REF30/sessions 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==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com

回應

code language-https

HTTP/1.1 200 OK

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

{
    "actionName": "authorize",
    "actionType": "direct",
    "reasonType": "degraded",
    "url": "/api/v2/REF30/decisions/authorize/Cablevision",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}

recommendation-more-help

pass-help-authentication

建立驗證工作階段 create-authentication-session

請求 request

回應 response

成功 success

錯誤 error

範例 samples

​1. 建立驗證工作階段，但不遺失引數

​2. 建立缺少引數的驗證工作階段

​3. 當有效的設定檔已存在時，建立驗證工作階段

​4. 使用基本或促銷臨時傳遞建立驗證工作階段（不需要）

​5. 套用降級時建立驗證工作階段

1. 建立驗證工作階段，但不遺失引數

2. 建立缺少引數的驗證工作階段

3. 當有效的設定檔已存在時，建立驗證工作階段

4. 使用基本或促銷臨時傳遞建立驗證工作階段（不需要）

5. 套用降級時建立驗證工作階段