アカウント更新API

アクセス権限
特権 サーバ管理 テナント管理 シナリオ設計 AIML編集者

アカウントの更新を行うAPIです。

ご注意

組織メンバー登録を行っていないアカウントに対してアカウント更新を行った場合、APIを実行したユーザの権限に応じて動作が異なります。

  • サーバ管理者以上 ・・・ アカウント更新可能。
  • テナント管理者 ・・・ アカウント更新不可。(403(Forbidden)を返します)

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/accounts/{accountId}

リクエスト

Method PUT
Header Authorization ログインAPIで払い出したアクセストークンを指定します。
  Content-Type application/json;charset=UTF-8
Body JSON形式。(詳細はリクエストパラメータを参照)

レスポンス

ステータスコード 成功

  • 204(No Content) 

エラー

  • 400(Bad Request)
  • 401(Unauthorized)
  • 403(Forbidden)
  • 404(Not Found)
  • 409(Conflict)
  • 429(Too many requests)
Body 成功:なし エラー:JSON形式

URLパラメータ

パラメータ名 説明
accountId 更新する対象のアカウントIDを指定します。

リクエストパラメータ

ログインしたユーザの権限によって、設定可能なキーが異なります。権限については説明欄をご覧ください。
また、権限によらず最低1つのキーを指定してください。

キー
必須 説明
accountName string アカウント名を最大180文字で設定します。
password string パスワードを設定します。
アカウント名と異なる値を設定してください。
パスワードは8文字以上180文字以内、英・数・記号の2つ以上を組み合わせて設定してください。
上記に該当しない場合、HTTPステータスコード400(Bad Request)を返却します。
description string 表示名を最大100文字で設定します。
authorization integer アクセス権を設定します。
登録者以上のアクセス権を設定することは出来ません。

アクセス権

  • 0 … 特権
  • 1 … サーバ管理
  • 2 … テナント管理
  • 3 … シナリオ設計
  • 4 … AIML編集
enable boolean 有効フラグを設定します。
eternity boolean サーバ管理者以上 パスワード有効期限を無期限とするかを設定します。
パスワード指定があるときのみ設定が有効になります。
trueを設定した場合、パスワードの有効期限を無期限 (2038年まで有効) にします。
省略時は設定を引き継がず、falseが設定されます。

レスポンスパラメータ

レスポンスパラメータはありません。

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  アカウント名不正 なし
  パスワード強度不足
  指定アクセス権不正 なし
  有効フラグ不正 なし
401(Unauthorized)
  トークン不正 なし
  パスワードが期限切れもしくは旧式や初期パスワード なし
403(Forbidden)
  アクセス権不正 なし
429(Too many requests)
  ロックアウト なし