8.1. 管理者登録

POST /1/_sysadm/_/developers

管理者を登録する

Request Headers:
 
  • X-Developer-Token -- 管理者用セッショントークン(オプション)
  • Content-Type -- application/json, application/yaml のいずれか
Request JSON Object:
 
  • developer.name (string) -- 名前(必須)
  • developer.email (string) -- E-Mail(必須)
  • developer.password (string) -- パスワード(必須)
  • developer.forceChangePassword (boolean) -- 次回ログイン時パスワード強制変更フラグ(オプション)
  • developer.isSysAdmin (boolean) -- システム管理者の有効フラグ(オプション)
Status Codes:
Response JSON Object:
 
  • developer._id (string) -- 管理者ユーザID
  • developer.name (string) -- 名前
  • developer.email (string) -- E-Mail
  • developer.forceChangePassword (boolean) -- 次回ログイン時パスワード強制変更フラグ
  • developer.isSysAdmin (boolean) -- システム管理者の有効フラグ

リクエストボディ

YAML 形式によるリクエストの例を以下に示す。

developer:
  name: developer1
  email: example@test.com
  password: passWord
  forceChangePassword: true
  isSysAdmin: false

レスポンスボディ

レスポンスは JSON で返却される。例を示す。

{
  "developer":{
    "_id": "5a93e8005bd67428ee3fac08",
    "name": "developer1",
    "email": "example@test.com",
    "forceChangePassword": true,
    "isSysAdmin": false
  }
}

注意事項

  • システム管理者権限が必要。
  • セルフサインアップ設定が有効の場合、未ログインユーザによる登録が可能。
  • 以下のフィールドはシステム管理者権限でのみ設定可能。
    • forceChangePassword
    • isSysAdmin
  • 名前、メールアドレス、パスワードは必須フィールドである。
  • 必須以外のフィールド省略時は、デフォルト値を設定する。
    • forceChangePassword : false
    • isSysAdmin : false