Skip to main content
このページは Authlete 3.0 用です。2.x の場合は クイックスタート(2.x) をご覧ください。

1. Authlete アカウントを作成する

Authlete を使用するにはアカウントが必要です。登録後、管理コンソールを通じてすべての機能を設定できます。 Authlete の Web サイトにアクセスし、右上の Free Trial (無料トライアル) をクリックします。
右上に無料トライアルボタンが表示されたAuthleteウェブサイトホームページ
お好みの登録方法を選択します。ソーシャルログイン (Google またはGitHub) またはメールアドレスでサインアップできます。
登録オプションを表示するサインアップページ: GoogleおよびGitHubソーシャルログインボタン、およびメールアドレスサインアップフィールド
ソーシャルログインまたはメールアドレスの確認後、First NameLast NameOrganization Name の入力と(メールアドレス登録の場合には Password も)、プライバシーポリシーと利用規約の確認を行い、Register をクリックしてサインアップを完了します。
名、姓、組織名の入力フィールドを備えたユーザープロフィールフォーム、プライバシーポリシーと利用規約を確認するチェックボックス、および青い登録ボタン

2. サービスを作成する

サインアップ直後、Services ページにリダイレクトされます。このページには Organization (サインアップ時に作成) のすべての Service が表示されます。 Service はあなたの認可サーバーのバックエンドです。Service には、認可サーバーを本番運用するために必要なすべての設定 (OAuth/OIDC 設定、トークン管理、セキュリティポリシーなど) が含まれます。 新しい Service を Organization に追加するには、Create Service をクリックします。
組織の既存サービスのリストを表示するサービスページと、右上の青いサービス作成ボタン
  1. お好みの API Cluster の場所 (例: US) を選択します。Service のすべてのデータが、ここで選択した Cluster に保存されます。データレジデンシーと環境分離の要件に基づいて Cluster を選択してください。
  2. Service Name (例: Sample Service) を入力します。
  3. Create をクリックして、セットアップを完了します。
APIクラスタ位置を選択するドロップダウンメニュー、サービス名の入力フィールド、および青い作成ボタンを表示する作成サービスフォーム
これで新しい Service の作成が完了しました。

3. サービスアクセストークンを作成する

Authlete API を呼び出すには、Service Access Token による認証が必要です。 新しく作成した Service の Service Settings をクリックします。
新しく作成されたサービスのサービス設定オプションが表示されているサービス概要ページ
  1. Service Identifier の値 (例: 3615784225) をメモします (Authlete API の多くが、リクエスト時にこの値を必要とします)。
  2. Create Token をクリックして、新しい Service Access Token を作成します。
サービス識別子の値を表示し、新しいサービスアクセストークンを生成する青いトークン作成ボタンを表示するサービス設定ページ
  1. Token Name (例: oauth-server-token) を入力します。
  2. Expiration Date を指定します。
  3. 適切な Permission (例: Authorization Server プリセット) を選択します。
  4. Create Token をクリックします。
oauth-server-tokenのトークン名フィールド、日付ピッカーの有効期限フィールド、オレンジでハイライトされた認可サーバーオプションの権限プリセットセクション、下部の青いトークン作成ボタンを表示するサービスアクセストークン追加ダイアログ
新しい Service Access Token がリストに表示されます。
  1. Copy または Show をクリックしてトークン値を取得します。この値を、以降の API リクエスト時の認証に用います。また、この値は作成時のみ表示されることにご注意ください。
  2. Back to Service Overview をクリックして、Service のメインページに戻ります。
新しく作成されたトークンの横にコピーボタンと表示ボタンが表示されているサービスアクセストークンリストと、メインサービスページに戻るサービス概要へのバックリンク
これでAuthlete APIをテストする準備ができました!

4. Authlete API を呼び出す

最初の API リクエストを、/service/configuration API に送信してみましょう。この API は OIDC ディスカバリーエンドポイントのバックエンドとして機能し、同エンドポイントがクライアント (OIDC リライングパーティー) からのリクエストに応じて返却する OpenID プロバイダーメタデータを生成します。 以下は curlAPI エクスプローラー を用いる例です。プレースホルダーを実環境の値に置き換えてください。

curl を使用する

ターミナルで以下のコマンドを実行して、HTTP GET リクエストを送信します:
成功した場合、API は以下のような OpenID プロバイダーメタデータを返します:

API エクスプローラーを使用する

/service/configuration API リファレンスページを開き、Try it ボタンをクリックします。
/service/configurationエンドポイントのAPIエクスプローラーインターフェース、クリックしてAPIをテストする準備ができた試してみるボタン
  1. API Cluster のホスト名を選択します。
  2. Service Access Token を入力します。
  3. Service ID を入力します。
  4. Send をクリックします。
サービスIDとサービスアクセストークンの入力フィールド、およびAPIリクエストを実行する青い送信ボタンを表示するAPIエクスプローラーフォーム
API レスポンスはレスポンスセクションに表示されます。
APIエクスプローラーのレスポンスセクションに表示されたAPIレスポンス。発行者、サポートされているスコープ、応答タイプを含むサービス構成の詳細を含むJSONデータを表示

次のステップ

これで Authlete アカウントのセットアップとサービス設定が完了しました。さらに詳しく探索してみましょう。
  • OAuth 2.0 Basics - API Tutorials: curl や他のツールを使用して API を直接呼び出して、Authlete がどのように機能するかを学びます。
  • Using Demo Authorization Server: Authlete API を用いて実装された、オープンソースの認可サーバーフロントエンドをデプロイして、実際の OAuth/OIDC フローをテストします。

Extra: OAuth/OIDC フローの処理

Authlete API による、OAuth/OIDC フローの処理を、認可リクエストのサンプルをもとに確認してみましょう。

クライアントを作成する

Client は、認可サーバーに対してトークン発行をリクエストしたり、リソースサーバーの保護されたリソースにアクセスするアプリケーションを表しています。Client は特定の Service のコンテキスト内で管理されます。 Services ページで、画面の右上にある Create Client ボタンをクリックします。
クリック準備ができた画面の右上に配置されたクライアント作成ボタンを備えたサービスページ
Client Name を入力して、Create をクリックします。
クライアント名の入力フィールドと新しいクライアントを追加する青い作成ボタンを備えたクライアント作成ダイアログフォーム
Client の詳細が表示されます。必要に応じて Client IDClient Secret をメモします。アプリケーションのリダイレクト URI を登録するために、Redirect URIs セクションの Add をクリックします。
クライアントIDとクライアントシークレットの値を表示するクライアント詳細ページ、リダイレクトURIセクション、およびアプリケーションリダイレクトURIを登録する追加ボタン
例として、https://client.example.org/cb/example.com を入力して Save Changes をクリックします。
例の値 https://client.example.org/cb/example.com のリダイレクトURIの入力フォーム、およびエントリを確認する青い変更を保存ボタン

「認可リクエスト処理」API を呼び出す

Try /auth/authorization API ツールに移動します。
  1. API Cluster のホスト名を選択します。
  2. Service Access Token を入力します。
  3. Service ID を入力します。
  4. 以下の文字列 (認可リクエストの内容) を parameters フィールドに入力します。なお、 client_id の値 (2329821874) は、前の手順で作成した実際の値に変更してください。
  5. Send をクリックします。
API Explorer showing the /auth/authorization endpoint with parameters entered
API レスポンスがレスポンスセクションに表示されます。
パラメータが入力され、レスポンスセクションに表示された/auth/authorizationエンドポイントのAPIエクスプローラー。認可リクエストの結果を表示するJSONレスポンス