クイックガイド

このドキュメントについて

このドキュメントは、Authleteを使い、OAuth 2.0 に準拠した認可サーバーを動かすためのクイックガイドです。

アカウント登録

まず初めに、アカウント登録しましょう。登録完了後、メールが送られます。その中に、OAuth 2.0 を試すための説明も書かれています。

OAuth 2.0 を試す

アカウント登録完了後、直ちに OAuth 2.0 のフローを試せます! これは、アカウント作成と同時に、サンプルの認可サーバー(=サービス)1つ、クライアントアプリ1つが自動で登録されるためです。

認可リクエストを行う

メールに記載されている Authorization Endpoint ボタンをクリックしてみてください。Web ブラウザ上で、認可画面が表示されると思います。

クレデンシャル情報を入力する

表示された認可画面に、サービスの API キーと API シークレットを入力してみましょう。これらの情報は、メールにある Service Owner Console ボタンをクリックすることで確認できます。

リクエストを認可する

表示された認可画面の Authorize ボタンをクリックしてみてください。そうすることで、リダイレクト・エンドポイントにリダイレクトされます。そこで、URL のフラグメント部に格納されたアクセストークンを確認することができます。

https://api.authlete.com/api/mock/redirection/SERVICE_API_KEY
#access_token=wAwuQSkePLk2D6rgGnuXQAtJHmFitVKoXIIPAY-3rzw
&token_type=Bearer&expires_in=86400&scope=

おめでとうございます!これで、OAuth2.0 のフローに沿って、アクセストークンを発行することができました!

認可サーバーを実装する

これまでは、Authlete が用意した標準実装を使ったデモを紹介しました。この標準実装以外にも、Authlete の Web API を使い、ご自身で認可サーバーを実装することも可能です。

例えば、java-oauth-server は、Authlete の Web API を使って設計された、オープンソースの認可サーバーになります。これは、Java を使ったサンプル実装例であり、独自の認可サーバーを構築する際の参考となるものです。

Authlete はバックエンドの仕組みであり、各種サービス、クライアントアプリおよび発行されるトークンの情報はすべて、Authlete 上のデータベースで管理されます。つまり、お客様側でデータベースを準備していただく必要はなく、下記のいくつかのコマンドだけで、認可サーバーが動き始めます。

詳細は java-oauth-server のドキュメントをご参照ください。

$ git clone https://github.com/authlete/java-oauth-server.git
$ cd java-oauth-server
$ vi authlete.properties
$ mvn jetty:run"

詳細は spring-oauth-server のドキュメントをご参照ください。

$ git clone https://github.com/authlete/spring-oauth-server
$ cd spring-oauth-server
$ vi authlete.properties
$ mvn spring-boot:run

詳細は csharp-oauth-server のドキュメントをご参照ください。

$ git clone https://github.com/authlete/csharp-oauth-server
$ cd csharp-oauth-server/AuthorizationServer
$ vi authlete.properties
$ dotnet run

詳細は authlete-php-laravel のドキュメントをご参照ください。

$ laravel new authorization-server
$ cd authorization-server
$ composer require authlete/authlete-laravel
$ php artisan authlete:authorization-server
$ vi config/authlete.php

ご自身で Authlete の Web API を使って認可サーバーを実装・運用される場合、認証コールバックエンドポイントを実装する必要はありません。その代わり、エンドユーザーの認証に関する部分はご自身で実装いただく必要があります。

次のステップ

Authlete API チュートリアル

認可サーバーが Authlete API を活用する際の、しくみを理解するためのチュートリアルです。詳細は、Authlete API チュートリアルをご参照ください。

サービス管理者コンソール

サービス管理者コンソールは、認可サーバーを運用する者が、各サービスを管理するためのコンソールです。詳細は、サービス管理者コンソールをご参照ください。

クライアントアプリ開発者コンソール

クライアントアプリ開発者コンソールは、クライアントアプリの開発者が、各クライアントアプリを管理するためのコンソールです。詳細は、クライアントアプリ開発者コンソールをご参照ください。

リソースサーバー

OAuth 2.0 を実装する主な目的は、アクセストークンを使って、Web API を保護することです。リソースサーバーの詳細は、 リソースサーバーをご参照ください。