/auth/login

<< Click to Display Table of Contents >>

Navigation:  API V3 マニュアル > リファレンス > auth >

/auth/login

FileBlogにログインし、アクセストークンを取得します。

アクセストークンとは

アクセストークンとは、認証済みユーザーを識別するための半角英数32バイトの文字列です。

各APIは/auth/loginで取得したアクセストークンをHTTPヘッダに以下の形式で指定する必要があります。

Authorization: Bearer <アクセストークン>

取得したアクセストークンはログアウト(/auth/logout)するか、セッションがタイムアウトするまで有効です。

※万一、有効なアクセストークンが流出した場合FileBlogに不正アクセスされる危険があります。アクセストークンが不要になった場合は速やかにログアウト(/auth/logout)を実行してアクセストークンを無効にしてください。

HTTP リクエスト

POST http://<ホスト名>/fileblog/api/v3/auth/login
Content-Type: application/json; charset=utf-8
 
{
 userid:"test",
 password:"pass",
 domain:"fileblog"
}

リクエストパラメータ

名前

説明

userid

String, 必須

ユーザー名を指定します。

password

String, 必須

パスワードを指定します。

domain

String

ドメイン名を指定します。デフォルトは空です。

sso

Boolean

シングルサインオン用のアクセストークンを取得する場合にTrueをセットします。取得したアクセストークンは http://$(host)/fileblog/login.php?sessionid=$(access_token)のURLをブラウザに開かせることでシングルサインオンできます。ただし、このアクセストークンはAPI呼出しには利用できません。

レスポンス

HTTP/1.1 200 OK
{
 "access_token": "CA4C1E2219374643ACBA8B4BEE12319F"
}

リクエストが成功すると、レスポンスコードが200、レスポンスボディにJson文字列で結果が返されます。

レスポンスパラメータ

名前

説明

access_token

String

アクセストークンです。

エラーレスポンス

※その他のエラーについてはこちらをご覧ください。