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

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

スロットルメカニズム

Adobe Pass認証 REST API は、 スロットルメカニズムによって制御されます。

応答形式 response-formats

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

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

< レジストリ_FQDN>:

<SP_FQDN>:

Web サービスの概要 web_srvs_summary

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

共有済み
Web サービスエンドポイント
説明
ホスト:
呼び出し元
1.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode
ランダムに生成された登録コードとログインページ URI を返します
2
Adobe
Reg コード サービス
スマートデバイス
2.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
登録コード UUID、登録コード、ハッシュ化されたデバイス ID を含む登録コードレコードを返します
8
Adobe
Reg コード サービス
Adobe Pass 認証
3.
<SP_FQDN>/api/v1/config/
{requestorId}
リクエスターに設定された MVPD のリストを返します
5
Adobe
Adobe Pass
authentication
Service
ログイン
Web
App
4.
<SP_FQDN>/api/v1/authenticate
MVPD選択イベントを通知して AuthN プロセスを開始します。 認証データベースにレコードを作成します。このレコードは、MVPDからリクエストが成功した場合に紐付けされます(手順 13)
7
Adobe
Adobe Pass
authentication
Service
ログイン
Web
App
5.
SAML アサーションコンシューマー
Adobe Pass認証とMVPDの間の既存の SAML ワークフロー
13
Adobe Pass
authentication
Service
Adobe Pass 認証
6.
<SP_FQDN>/api/v1/checkauthn/
{registrationCode}
ログイン Web アプリケーションは、試行されたログインフローが成功したかどうかを確認できます
Adobe Pass
認証
サービス
ログイン
Web
アプリ
7.
<SP_FQDN>/api/v1/tokens/authn
AuthN トークン関連メタデータを取得します
15
Adobe Pass
authentication
Service
スマートデバイス
8.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
登録コードレコードを削除し、再利用のために登録コードを解放します
16
Adobe
Reg コード サービス
Adobe Pass 認証
9.
<SP_FQDN>/api/v1/authorize
認証応答を取得します。
17
Adobe Pass
authentication
Service
スマートデバイス
10.
<SP_FQDN>/api/v1/checkauthn
デバイスに期限切れでない AuthN トークンがあるかどうかを示します。
Adobe Pass
authentication
Service
スマートデバイス
11.
<SP_FQDN>/api/v1/tokens/authn
見つかった場合は、AuthN トークンを返します。
Adobe Pass
authentication
Service
スマートデバイス
12.
<SP_FQDN>/api/v1/tokens/authz
見つかった場合は、AuthZ トークンを返します。
Adobe Pass
authentication
Service
スマートデバイス
13.
<SP_FQDN>/api/v1/tokens/media
見つかった場合、短いメディアトークンを返します – /api/v1/mediatoken と同じ
Adobe Pass
authentication
Service
スマートデバイス
14。
<SP_FQDN>/api/v1/mediatoken
ショートメディアトークンを取得
Adobe Pass
authentication
Service
スマートデバイス
15.
<SP_FQDN>/api/v1/preauthorize
事前承認済みリソースのリストを取得します
Adobe Pass
authentication
Service
スマートデバイス
16。
<SP_FQDN>/api/v1/preauthorize/{code}
事前承認済みリソースのリストを取得します
Adobe Pass
authentication
Service
ログイン 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
一時パスまたはプロモーション一時パスの認証トークンの作成
該当なし
Adobe Pass
authentication
Service
スマートデバイス

REST API セキュリティ security

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

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b