クイックスタート

はじめに

このクイックガイドでは、Authlete アカウントを作成し、Authlete 管理コンソールの概要を紹介します。

このチュートリアルでは以下を解説します:

  1. Authlete アカウントへのサインアップ
  2. Authlete 管理コンソールの概要

Authlete へのサインアップ

Authlete を利用するには Authlete アカウントの作成が必要です。アカウントを作成すると、管理コンソールを使用して Authlete のすべての機能を利用できます。

ステップ 1: アカウントを作成する

Authlete ウェブサイトで「Register」をクリックしてください。

homepage

ステップ 2: メールアドレスを入力する、またはソーシャルログインで続行する

メールアドレスを入力するか、Google または GitHub のソーシャルログインを選択します。

signup

ステップ 3: メールアドレスを確認する(ソーシャルログインを使用しない場合)

メールアドレスを入力後、以下のページが表示されます

verification-link-sent

メールに届いたリンクを確認して、メールアドレスを認証してください。または、メールに記載されたコードを別のリンク先で入力することも可能です。

email-verification

Authlete から送信されるメール認証用のメール

enter-code

メール内の「Verify Email」ボタンをクリックするか、コードを手動で入力してこの手順をスキップしてください

ステップ 4: アカウント情報を入力する

名前やパスワードなど、初期情報を入力してください。

user-info

アカウント作成に必要な基本情報の入力フォーム

Authlete のプライバシーポリシーに同意する必要があります。同意後、「Register」をクリックしてください。

これで Authlete アカウントの登録が完了し、次のステップに進む準備が整いました!

Authlete コンソール概要

Authlete 管理コンソールは、Authlete の機能を管理および構成するためのダッシュボードです。アカウント作成後、コンソールにログインすることで、組織、サービス、クライアントの作成や設定を行うことができます。

  1. すべての組織ページ

管理コンソールの最初のページは「すべての組織ページ」です。組織は、1つ以上のサービスを共有するユーザーグループです。

org-empty

作成した組織、または所属するすべての組織がここに表示されます。

  1. 組織を作成する

まだ組織に所属していない場合は、新しい組織を作成してください。「組織を新規作成」ボタンをクリックし、組織名を入力して「作成」を押すだけで完了します。

new-org
  1. 組織設定
org-settings

「基本設定」セクションでは、組織の名前を変更したり、アクセストークンを作成および管理できます。

user-permissions

組織は、サービスやクライアントへのアクセス権限を共有するユーザーグループとして機能します。必要に応じて、新しいユーザーを組織に追加し、これらのサービスやクライアントを利用、変更、構成できるようにします。

invites-list

新しいユーザーを追加するには、サイドバーの「ユーザー権限」項目に移動し、右上の「ユーザーを招待」をクリックします。新しいユーザーのメールアドレスを入力し、そのユーザーに割り当てるアクセスレベルの権限を設定します。デフォルトでは、招待されたユーザーの権限は「Viewer」に設定されています。設定が完了したら、「招待を送信」を押します。まだ招待を受け入れていないユーザーは「招待済み」タブに表示されます。

user-invite-form

ユーザーに割り当てられた権限は、いつでもテーブルビューのセレクターで変更可能です。また、管理者は「削除」アイコンを使用して組織内のユーザーを削除することもできます。

ユーザー権限とロールの詳細については、近日公開予定のドキュメントをご参照ください。

  1. すべてのサービスページ

組織内の最初のページは「すべてのサービスページ」です。このページには、組織で作成されたすべてのサービスがリスト表示されます。

  • サービス は、認可サーバーのバックエンドを表します。OAuth や OpenID Connect 設定、トークン管理、その他のセキュリティ設定など、認可サーバーを運用するために必要なすべての設定が含まれています。

  • クライアント は、認可サーバーにアクセストークンを要求するアプリケーションを表します。このアプリケーションは、リソースサーバーと連携して保護されたリソースにアクセスします。

Authlete では、複数の API クラスターにまたがってサービスを実行できます。これにより、データの所在地要件や環境(例: 開発、テスト、本番環境)の分離に応じてクラスターを選択できます。

services-list

作成済み、またはアクセス権限を持つすべてのサービスがここに表示されます。組織間の切り替えは、ナビゲーションラベル(組織名が表示されている箇所)を使用するか、「戻る」ボタンで前のページに戻って選択できます。また、「All Clusters」ラベルをクリックして、異なる API クラスターにあるサービスをフィルタリングできます。

サービスの新規作成

新しいサービスを作成するには、画面右上の「サービスの新規作成」ボタンをクリックしてください。Authlete を利用した認可サーバーを運用するには、サービスの作成が必要です。

service-creation

サービスを実行する場所に応じて、適切な API クラスター を選択してください。この選択は重要です。すべてのサービスデータは選択したクラスターに保存されます。次に、「サービス名(例: このチュートリアルでは「Sample Service」)」、オプションで「サービスの詳細情報」と「発行者識別子」を入力します。また、必要に応じて「指定可能なサービスプロファイル」を選択することもできます。入力が完了したら、「作成」をクリックして新しいサービスを作成します。

API クラスターの詳細については、近日公開予定のドキュメントをご参照ください。

「指定可能なサービスプロファイル」については、近日公開予定のドキュメントをご参照ください。

すべてのクライアントページ

サービス内の最初のページは「すべてのクライアントページ」です。クライアントは、認可サーバーとやり取りしてトークンを要求するアプリケーション、またはリソースサーバーと連携して保護されたリソースにアクセスするアプリケーションを表します。クライアントは、認可サーバーのバックエンドを表すサービス内で作成および設定されます。

clients-list

作成済み、またはアクセス権限を持つすべてのクライアントがここに表示されます。他のサービスに切り替えるには、「戻る」ボタンを使用してすべてのサービスを表示し、別のサービスを選択してください。

クライアントを新規作成

まだクライアントが存在しないサービスでは、新しいクライアントを作成する必要があります。画面右上の「クライアントを新規作成」ボタンをクリックして開始してください。

client-creation

クライアント名 とオプションで クライアントの説明 を入力してください。その後、 「作成」 ボタンをクリックして新しいクライアントを作成します。

次のステップ

Authlete アカウントをセットアップし、クライアントを作成したので、次はさらにセットアップを進めてみましょう。クイックセットアップガイド を読み、認可サーバーの構成と OAuth および OpenID Connect を使用して最初のトークンを取得する方法を学びましょう。

準備はできましたか? Authlete アカウントにサインアップする ことで、Authlete のすべての機能を利用できます!