アクセストークンプロファイルを構成する
どのアクセストークンプロファイル(Auth0トークンプロファイル、またはRFC 9068トークンプロファイル)をAPIに使用するか選択できます。構成するアクセストークンプロファイルは、APIに発行されたアクセストークンの形式を決定します。
デフォルトで、Auth0はAuth0トークンプロファイルを使用してアクセストークンを発行します。Auth0トークンプロファイルは、JSON Webトークン(JWT)形式のアクセストークンを発行し、クレームの形式にあるエンティティについての情報を含みます。
また、Auth0はRFC 9068トークンプロファイルをサポートします。RFC 9068トークンプロファイルは、IETF JWT Profile for OAuth 2.0 Access Tokens(RFC 9068)に準拠したJWTとして形式化されたアクセストークンを発行します。これらのトークンプロファイルの違いについては、「アクセストークンプロファイル」をお読みください。
APIを登録する際、Auth0 Dashboardのアクセストークンプロファイルを選択できます。APIを登録したら、Management APIとAuth0 Dashboardを使用して、いつでもアクセストークンプロファイルを構成できます。
APIに対するアクセストークンプロファイルを構成する
1. [Dashboard] > [Applications(アプリケーション)] > [APIs]に移動し、APIの名前をクリックすると表示されます。
2. [Access Token Settings(アクセストークン設定)]に移動し、[JSON Web Token(JWT) Profile(JSON Webトークンプロファイル)]の下にあるアクセストークンプロファイルを選択します。選択したプロファイルは、APIに発行されるアクセストークンの形式とクレームを決定します。サポート値はAuth0
とRFC 9068
です。2つのプロファイルの違いについての詳細は、「アクセストークンプロファイル」をお読みください。
3. [Save(保存)]をクリックします。
Management APIを使用する際、アクセストークンプロファイルをトークンダイアレクトとして参照します。アクセストークンプロファイルを構成するには、Management APIで、APIに対するtoken_dialect
パラメーターを設定します。
次のコードサンプルは、リソースサーバーエンドポイントの更新にPATCH要求を行います。
curl --request PATCH \
--url 'https://{yourDomain}/api/v2/resource-servers/API_ID' \
--header 'authorization: Bearer MGMT_API_ACCESS_TOKEN' \
--header 'content-type: application/json' \
--data '{"token_dialect": "TOKEN_DIALECT" }'
Was this helpful?
次のテーブルで説明されている通り、API_ID
、MGMT_API_ACCESS_TOKEN
、TOKEN_DIALECT
をそれぞれの値に置き換えます。
| パラメーター | 説明 | | - | - | | API_ID
| トークンのダイアレクトを更新したいAPIのID。 | | MGMT_API_ACCESS_TOKEN
| update:resource_servers
のスコープを持つ[Management APIのアクセストークン](https://auth0.com/docs/ja-jp/api/management/v2/tokens) | | TOKEN_DIALECT
| 指定APIのアクセストークンのダイアレクト。詳しくは、[トークンのダイアレクトオプション](#token-dialect-options)をご覧ください。 |
トークンダイアレクトのオプション
Auth0は次のトークンダイアレクトをサポートします:
値 | 説明 |
---|---|
access_token |
デフォルトのAuth0トークンプロファイルはJSON Web Token(JWT)形式のアクセストークンを生成します。詳細については、「アクセストークンプロファイル」をお読みください。 |
access_token_authz |
permissions クレームのあるデフォルトのAuth0トークンプロファイル(access_token )です。RBAC権限については、「APIにロールベースのアクセス制御を有効にする」をお読みください。 |
rfc9068_profile |
RFC 9068トークンプロファイルはIETF JWT Profile for OAuth 2.0 Access Tokens(RFC 9068)に準拠したJWT形式のアクセストークンを生成します。詳細については、「アクセストークンプロファイルをお読みください。 |
rfc9068_profile_authz |
permissions クレームのあるRFC 9068プロファイル(rfc9068_profile )です。RBAC権限については、「APIにロールベースのアクセス制御を有効にするをお読みください。 |