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

API のアクセストークンプロファイルの設定方法を説明します。

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

デフォルトでは、Auth0 は Auth0 トークンプロファイルを使用してアクセストークンを発行します。Auth0 トークンプロファイルでは、アクセストークンは JSON Web Tokens (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 では、アクセストークンプロファイルを token dialect と呼びます。アクセストークンプロファイルを設定するには、Management API を使用して API の token_dialect パラメーターを設定します。

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

API_ID、MGMT_API_ACCESS_TOKEN、TOKEN_DIALECT を、次の表で説明するそれぞれの値に置き換えます。

パラメーター	説明
API_ID	トークンダイアレクトを更新する対象 API の ID。
MGMT_API_ACCESS_TOKEN	スコープ update:resource_servers を持つ Management API 用のアクセストークン。
TOKEN_DIALECT	指定した API のアクセストークンダイアレクト。詳しくは、Token dialect options を参照してください。

​

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

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

値	説明
access_token	デフォルトの Auth0 トークンプロファイルでは、JSON Web Token (JWT) 形式のアクセストークンが生成されます。詳しくは、Access Token Profiles を参照してください。
access_token_authz	permissions クレームを含む、デフォルトの Auth0 トークンプロファイル (access_token)。RBAC の権限について詳しくは、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 の権限について詳しくは、Enable Role-Based Access Control for APIs を参照してください。