(レガシー) REST API リファレンス rest-api-reference

NOTE
このページのコンテンツは、情報提供のみを目的として提供されています。 このAPIを使用するには、Adobeの現在のライセンスが必要です。 無断使用は認められません。
IMPORTANT
製品のお知らせ ページに集計されている最新のAdobe Pass認証製品のお知らせと廃止予定について、常に情報を得てください。

スロットル機構

Adobe Pass Authentication REST APIは、​ スロットル メカニズム ​によって管理されます。

応答形式 response-formats

NOTE
これらのサービスで提供されるAPIは、(応答を返すAPIの場合) XMLまたはJSONで応答を返すことができます。 リクエストでレスポンス形式を指定するには、次の3つの方法があります。
  • HTTP Accept Headerをapplication/xmlまたはapplication/jsonに設定します。
  • リクエストペイロードで、パラメーターformat=xmlまたはformat=jsonを指定します。
  • 拡張子が.xmlまたは.jsonのweb サービスエンドポイントを呼び出します。 例:/regcode.xmlまたは/regcode.json
上記のいずれかの方法を指定できます。 競合する形式で複数のメソッドを指定すると、エラーや望ましくない出力が発生する場合があります。

REST API エンドポイント clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Web サービスの概要 web_srvs_summary

次の表に、クライアントレスアプローチで使用可能なweb サービスを示します。 詳しくは、web サービスエンドポイントをクリックしてください(リクエストとレスポンスのサンプル、入力パラメーター、HTTP メソッドなど)。

​| Sr | Web サービスエンドポイント | 説明 | . | ホスト先: | 呼び出し元 |
|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|-----------------------------------------------------------|-----------------------------|
| 1. | <REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode
| ランダムに生成された登録コードとログインページ URIを返します | 2 | Adobe
Reg Code Service | スマートデバイス |
| 2. | <REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
| 登録コード UUID、登録コード、およびハッシュ化されたデバイス IDを含む登録コードレコードを返します | 8 | Adobe
Reg Code Service | Adobe Pass 認証 |
| 3. | <SP_FQDN>/api/v1/config/
{requestorId}
| 要求者に対して設定されたMVPDのリストを返します | 5 | Adobe
Adobe Pass
認証
サービス |
Web
アプリにログイン |
| 4. | <SP_FQDN>/api/v1/authenticate | MVPDの選択イベントを通知して、認証プロセスを開始します。 MVPDから正常な応答を受信したときに調整される認証データベースのレコードを作成します(ステップ 13) | 7 | Adobe
Adobe Pass
認証
サービス |
Web
アプリにログイン |
| 5. | SAML アサーションコンシューマー | Adobe Pass認証とMVPD間の既存のSAML ワークフロー | 13 | Adobe Pass
認証
サービス | Adobe Pass 認証 |
| 6. | <SP_FQDN>/api/v1/checkauthn/
{registrationCode}
| ログイン Web アプリは、試行されたログインフローが成功したかどうかを確認できます | | Adobe Pass
認証
サービス |
Web
アプリにログイン |
| 7. | <SP_FQDN>/api/v1/tokens/authn | AuthN トークン関連のメタデータを取得します | 15 | Adobe Pass
認証
サービス | スマートデバイス |
| 8. | <REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
| reg コードレコードを削除し、再利用のためにreg コードをリリースします | 16 | Adobe
Reg Code Service | Adobe Pass 認証 |
| 9. | <SP_FQDN>/api/v1/authorize | 承認応答を取得します。 | 17 | Adobe Pass
認証
サービス | スマートデバイス |
| 10. | <SP_FQDN>/api/v1/checkauthn | デバイスに有効期限のないAuthN トークンがあるかどうかを示します。 | | Adobe Pass
認証
サービス | スマートデバイス |
| 11. | <SP_FQDN>/api/v1/tokens/authn | 見つかった場合は、AuthN トークンを返します。 | | Adobe Pass
認証
サービス | スマートデバイス |
| 12. | <SP_FQDN>/api/v1/tokens/authz | 見つかった場合は、AuthZ トークンを返します。 | | Adobe Pass
認証
サービス | スマートデバイス |
| 13. | <SP_FQDN>/api/v1/tokens/media | 見つかった場合は、/api/v1/mediatokenと同じショートメディアトークンを返します | | Adobe Pass
認証
サービス | スマートデバイス |
| 14. | <SP_FQDN>/api/v1/mediatoken | ショートメディアトークンを取得します | | Adobe Pass
認証
サービス | スマートデバイス |
| 15. | <SP_FQDN>/api/v1/preauthorize | 事前承認済みリソースのリストを取得します | | Adobe Pass
認証
サービス | スマートデバイス |
| 16. | <SP_FQDN>/api/v1/preauthorize/{code} | 事前承認済みリソースのリストを取得します | | Adobe Pass
認証
サービス | Web アプリへのログイン |
| 17. | <SP_FQDN>/api/v1/logout | ストレージからAuthNおよびAuthZ トークンを削除する | | Adobe Pass
認証
サービス | スマートデバイス |
| 18. | <SP_FQDN>/api/v1/tokens/usermetadata | 認証フロー完了後にユーザーメタデータを取得します | 該当なし | 該当なし | スマートデバイス |
| 19. | <SP_FQDN>/api/v1/authenticate/freepreview | Temp Passまたはプロモーション Temp Passの認証トークンを作成する | 該当なし | Adobe Pass
認証
サービス | スマートデバイス |

REST API セキュリティ security

すべてのAdobe Pass認証REST APIは、安全な通信のためにHTTPS プロトコルを使用して呼び出す必要があります。 さらに、呼び出されるAPIのほとんどは、​ アクセストークンの取得 API ドキュメントの説明に従って取得されたアクセストークンを含める必要があります。

recommendation-more-help
pass-help-authentication