ログイン

ユーザーから承認を取得し、ユーザーに代わってアクションを実行する方法。

スコープの説明

アプリケーションを登録し、ユーザーを認証するとき、生成されたトークンに何を許可するかを正確に定義する必要があります。OAuthスコープを使用してこれを実行します。各々のAPIメソッドは関連付けられたスコープが存在し、承認に使用されているトークンが、対応するスコープで生成されている場合にのみ呼び出すことができます。

スコープは登録時に指定したものだけを使用しなければなりません。アプリケーションを作成するとき、read write follow pushと指定すると、ただ単にすべての使用可能なスコープを要求したということになります。しかし、もっと詳細なスコープを使用して、あなたのアプリが本当に要求している機能だけ要求したほうが良いです。OAuthスコープで全てのスコープの一覧を見ることができます。各々のAPIメソッドのドキュメントでもそのAPIにアクセスするために必要なスコープを記載しています。

認証コードによる認証の一例

これは以前の認証フローに似ていますが、今回はユーザーからも承認を取得する必要があります。

Client IDとシークレット

まず、まだクライアントアプリケーションを作成していない場合は、アプリケーションの作成を見るか、直接POST /api/v1/appsでこのメソッドのドキュメントを見てください。client_idとclient_secretを使用します。

ユーザーの認証

ユーザーを認証するために、GET /oauth/authorizeにブラウザでリクエストしてください。その際以下のパラメータが必要です。

https://mastodon.example/oauth/authorize
?client_id=CLIENT_ID
&scope=read+write+follow+push
&redirect_uri=urn:ietf:wg:oauth:2.0:oob
&response_type=code

注意:

  • client_idとclient_secretはアプリケーションを登録するときに取得しています。
  • scopeはスコープは登録時に指定したものだけを使用してください。必要なものだけを使用してください。OAuthスコープで詳細な情報を見ることができます。
  • redirect_uriはアプリケーション登録時に指定したURIのうちの一つです。この例ではまだ「アウトオブバンド」を使用しています。つまり、取得したコードを手動で入力しないといけないということです。しかし、URIを指定した場合、そのコードはcodeパラメータとして付与され、リクエストハンドラでログに格納されます。詳細は、APIメソッドのドキュメントのレスポンスセクションを見てください。

トークンの取得

今、認証codeを持っています。リクエストのユーザーを認証するためアクセストークンを取得しましょう。以前と同様POST /oauth/tokenします。違うのは取得した認証codeを渡すというところだけです。

curl -X POST \
	-F 'client_id=your_client_id_here' \
	-F 'client_secret=your_client_secret_here' \
	-F 'redirect_uri=urn:ietf:wg:oauth:2.0:oob' \
	-F 'grant_type=authorization_code' \
	-F 'code=user_authzcode_here' \
	-F 'scope=read write follow push' \
	https://mastodon.example/oauth/token

注意:

  • client_idとclient_secretはアプリケーションを登録したときのレスポンスに含まれています。
  • redirect_uriはアプリケーション登録時に指定したURIのうちの一つです。
  • grant_typeはauthorization_codeを指定しますが、それでもデフォルトで readスコープが与えられます。ただし、ユーザーを認証する際に、特定のscopeを要求しましたはずです。今回もscopeに正確に同じ値をここに渡します。
  • The code can only be used once. If you need to obtain a new token, you will need to have the user authorize again by repeating the above Authorize the user step.
  • codeは一回限り有効です。もし新しいトークンを必要とする場合、ユーザーの認証に戻ってやり直す必要があります。

このメソッドのレスポンスはTokenエンティティです。access_tokenを要求します。一度アクセストークンを取得したら、ローカルにキャッシュしてください。アクセストークンをリクエストに含めるには、Authorization: Bearer アクセストークンを入力 HTTPヘッダーを付与してください。これは、例えば公開されていない情報を取得するときなど、OAuthを要求するいかなるAPIにアクセスする時にも必要です。[GET /api/v1/accounts/verify_credentials]で取得した認証情報が有効かどうかを確認できます。

curl \
	-H 'Authorization: Bearer アクセストークンを入力' \
	https://mastodon.example/api/v1/accounts/verify_credentials

トークンを正しく取得し、これを含めて上記ののようにアクセスした場合、そのユーザーのAccountエンティティにsourceが付与されたものが返ります。

認証されたユーザーとしてアクションを実行する

認証されたユーザーのトークンを付与すると、トークンのスコープ内にあるユーザーとして任意のアクションを実行できるようになります。

投稿とその削除

タイムライン

他のユーザーとの関わり

  • /api/v1/accountsで他のユーザーに対してアクションを実行できます。
  • /api/v1/follow_requestsでフォローリクエストを操作できます。
  • /api/v1/mutesでミュートしたユーザーの一覧を取得できます。
  • [/api/v1/blocks](/methods/accounts/blocks/でブロックしたユーザーの一覧を取得できます。

通知を取得する

検索・発見機能

セーフティ機能

アカウントの情報を編集

最終更新 July 1, 2020 · このページを改善する
他の言語: English