アクセストークンプロファイルを設定する

API のアクセストークンプロファイルを設定して、発行されるアクセストークンの形式とクレームを制御します。

使用する API の アクセストークンプロファイルは、Auth0 トークンプロファイルまたは RFC 9068 トークンプロファイルから選択できます。設定するアクセストークンプロファイルによって、その API 用に発行されるアクセストークンの形式が決まります。

デフォルトでは、Auth0 は Auth0 トークンプロファイルを使用してアクセストークンを発行します。Auth0 トークンプロファイルでは、アクセストークンはJSON Web トークン (JWTs) 形式で発行され、エンティティに関する情報をクレームとして含みます。

Auth0 は RFC 9068 トークンプロファイルもサポートしています。RFC 9068 トークンプロファイルでは、IETF JWT Profile for OAuth 2.0 Access Tokens (RFC 9068) に準拠した JWT 形式のアクセストークンが発行されます。これらのトークンプロファイルの違いについて詳しくは、Access Token Profiles を参照してください。

API を登録する際には、Auth0 Dashboard でアクセストークンプロファイルを選択できます。API の登録後は、Management API と Auth0 Dashboard を使用して、いつでもアクセストークンプロファイルを設定できます。

​

API のアクセストークンプロファイルを設定する

Auth0 Dashboard

1. Dashboard > Applications > APIs に移動し、詳細を表示する API の名前をクリックします。

2. Access Token Settings までスクロールし、JSON Web Token (JWT) Profile でアクセストークンプロファイルを選択します。選択したプロファイルによって、その API に対して発行されるアクセストークンの形式とクレームが決まります。サポートされている値は Auth0 と RFC 9068 です。2 つのプロファイルの違いについて詳しくは、Access Token Profiles を参照してください。

3. Save をクリックします。

Management API

Management API では、アクセストークンプロファイルをトークンダイアレクトと呼びます。アクセストークンプロファイルを設定するには、Management API を使用して API の token_dialect パラメーターを設定します。

次のコードサンプルは、Update a resource server endpoint に PATCH リクエストを送信します。

次の表の説明に従って、API_ID、MGMT_API_ACCESS_TOKEN、TOKEN_DIALECT をそれぞれ対応する値に置き換えます。

Parameter	Description
API_ID	トークンダイアレクトを更新する対象 API の ID。
MGMT_API_ACCESS_TOKEN	scope update:resource_servers を持つ Access Token for the Management API。
TOKEN_DIALECT	指定した API のアクセストークンのダイアレクト。詳しくは、Token dialect options を参照してください。

​

トークンダイアレクトのオプション

Auth0 では、次のトークンダイアレクトをサポートしています。

Value	Description
access_token	デフォルトの Auth0 トークンプロファイルは、JSON Web トークン (JWT) 形式のアクセストークンを生成します。詳しくは、Access Token Profiles を参照してください。
access_token_authz	permissions クレームを含むデフォルトの Auth0 トークンプロファイル (access_token)。RBAC の permissions について詳しくは、Enable Role-Based Access Control for APIs を参照してください。
rfc9068_profile	RFC 9068 トークンプロファイルは、IETF JWT Profile for OAuth 2.0 Access Tokens (RFC 9068) に準拠した JWT 形式のアクセストークンを生成します。詳しくは、Access Token Profiles を参照してください。
rfc9068_profile_authz	permissions クレームを含む RFC 9068 プロファイル (rfc9068_profile)。RBAC の permissions について詳しくは、Enable Role-Based Access Control for APIs を参照してください。