API の登録

Auth0 Dashboard で API を登録する方法を説明します。

Auth0 Dashboard で API を登録する前に、すでに 1 つの API が用意されています。それが Auth0 Management API です。Management API の機能や利用可能な endpoint の詳細については、Management API を参照してください。

1. Dashboard > Applications > APIs に移動し、+ Create API を選択します。

2. API に次の情報を入力し、Create をクリックします。

   フィールド	説明	例
   Name	API のわかりやすい名前です。機能には影響しません。	yourDomain
   Identifier	API の一意の識別子です。Auth0 では URL を使用することを推奨しています。Auth0 は末尾のスラッシュの有無を区別します。たとえば、https://example.com と https://example.com/ は 2 つの異なる識別子です。この URL は公開されている必要はありません。Auth0 がこの API を呼び出すことはありません。この値は後から変更できません。	https://{yourDomain}
   JSON Web Token (JWT) Profile	API に対して発行されるアクセストークンの形式を決定するプロファイルです。使用可能な値は Auth0 と RFC 9068 です。詳細については、Access Token Profiles を参照してください。	Auth0
   JSON Web Token (JWT) Signing Algorithm	アクセストークンの署名に使用するアルゴリズムです。使用可能な値は HS256、PS256、RS256 です。RS256 を選択すると、トークンはテナントの秘密鍵で署名されます。	RS256
   Access Policy for Applications within user flow	アプリケーションがユーザーに代わって API にアクセスできるようにします。詳細については、API Access Policies for Applications を参照してください。	Allow via client-grant
   Access Policy for Applications within client flows	マシン間アプリケーションが API にアクセスできるようにします。詳細については、API Access Policies for Applications を参照してください。	Allow via client-grant

3. Quickstart で説明されているとおりに API の実装を変更します。これには、あらかじめ用意された一覧から JWT ライブラリを選択し、そのライブラリを設定して API 内のアクセストークンを検証する作業が含まれます。

   
   新しいカスタム API を作成し、かつテナントにシングルページアプリケーションまたはネイティブアプリケーションがある場合は、これらのアプリケーションでログイン中のユーザーが、スコープを考慮しないアクセストークンを API 向けに生成できないようにするため、ロールベースアクセス制御 (RBAC) を有効にする必要があります。API で RBAC を有効にする方法については、Enable Role-Based Access Control for APIs を参照してください。

API で利用できるその他の Dashboard ビューは次のとおりです。

• Settings: API の設定を一覧表示します。一部の設定は編集可能です。ここでは、トークンの有効期限を変更したり、オフラインアクセスを有効にしたりできます (これにより Auth0 は、アプリケーションがこの API 用の refresh tokens を要求できるようになります) 。
• Scopes: 名前と説明を設定して、この API のスコープを定義します。
• Machine to Machine Applications: Client Credentials グラントが有効になっているすべてのアプリケーションを一覧表示します。デフォルトでは、このグラントは Regular Web Application とマシン間アプリケーションで有効です。これらのアプリケーションのいずれにも、API 用の access tokens をリクエストする権限を付与できます。必要に応じて、定義済みスコープの一部を選択し、認可済みアプリケーションのアクセスを制限することもできます。
• Test: 認可済みアプリケーションのいずれかを使ってサンプルの client credentials flow を実行し、すべてが想定どおりに動作することを確認します。

​

詳しくはこちら

• API の設定
• トークンのベストプラクティス
• 使用すべき OAuth 2.0 フローはどれですか？