5.1. ログイン¶

POST /1/_sysadm/_/auth/login¶

ログインを行う。ログインが成功すると、管理者用セッショントークンが払い出される。

Request Headers:
	Content-Type -- application/json
Request JSON Object:
	email (string) -- E-mail アドレス (必須) password (string) -- パスワード (必須)
Status Codes:	200 OK -- 正常にログインした 400 Bad Request -- パラメータ/リクエストボディ不正 401 Unauthorized -- 認証エラー 415 Unsupported Media Type -- Content-Type 不正
Response JSON Object:
	_id (string) -- 管理者ユーザID developerToken (string) -- 管理者用セッショントークン expire (integer) -- 管理者セッショントークンの有効期限 email (string) -- E-mail アドレス name (string) -- 名前 forceChangePassword (boolean) -- 次回ログイン時パスワード強制変更フラグ isSysAdmin (boolean) -- システム管理者フラグ

レスポンスボディの例

{
  "_id": "52116f01ac521e1742000001",
  "developerToken": "eyJ1c2VyX2lkI....a403dde3c3f704c5cd",
  "expire": 1376878239,
  "email": "admin@example.com",
  "name": "Administrator",
  "forceChangePassword": true,
  "isSysAdmin": true
}

注意事項

expireは、UNIX Time (1970-01-01 00:00:00 UTCからの経過秒数)で表現する。ログインから24時間後が設定される。
以後、管理者系APIでは、セッショントークンを X-Developer-Token ヘッダに指定すること。
管理者セッショントークンには有効期限があるので注意すること。期限切れとなった場合は再度ログインを行うこと。
セッショントークンの利用が終わったら、原則ログアウト APIを呼び出してトークンを無効化すること。