機能
初期ユーザー作成
処理概要
初期内部認証ユーザーを作成します。ロールは必ず“Administrator”に設定されます。
内部認証ユーザーが1人以上登録されている場合は使用できません。
パラメーター
パラメーター名 | 説明 | 指定 | 形式 | タイプ |
---|---|---|---|---|
name | ユーザー名を指定します。
半角スペースは使用できません。 | 必須 | string | query |
password | ユーザーパスワードを指定します。
半角スペースは使用できません。 | 必須 | string | query |
mail_address | メールアドレスを指定します。
半角スペースは使用できません。 | 任意 | string | query |
description | ユーザーの説明を記述します。
[例] | 任意 | string | query |
ステータスコード
本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。
200
ステータスコードの詳細は、「ステータスコード」を参照してください。
ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。
レスポンス詳細
JSON形式のレスポンスとして表示されます。
データを格納するキー名: user
単一のオブジェクトを返却
表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。
コード | キー | 説明 | 形式 | 列挙型定数 |
---|---|---|---|---|
200 | id | ユーザーID | integer | |
session_id | セッションID | integer | ||
name | ユーザー名 | string | ||
role | ユーザーの役割 | enum | Administrator: | |
mail_address | メールアドレス | string | ||
password_changed_at | パスワードの最終設定日時 | timestamp | ||
description | ユーザーの説明 | string |