アカウント情報取得API

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

アカウントの情報を取得するAPIです。

ご注意

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

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

エンドポイント

URL

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

リクエスト

Method GET
Header Authorization ログインAPIで払い出したアクセストークンを指定します。
Body なし

レスポンス

ステータスコード 成功

  • 200(OK) 

エラー

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

URLパラメータ

パラメータ名 説明
accountIds 情報を取得する対象のアカウントIDを指定します。
アカウントIDは「,」(カンマ)区切りで複数同時に指定できます。

リクエストパラメータ

リクエストパラメータはありません。

レスポンスパラメータ

キー 必須 説明
accounts object
配列
アカウントの情報が配列で設定されます。
  accountId integer アカウントIDが設定されます。
  accountName string アカウント名が設定されます。
  description string 表示名が設定されます。
  authorization integer アクセス権が設定されます。
  enable boolean 有効フラグが設定されます。
  createDate string アカウント作成日時が設定されます。
フォーマット:YYYY-MM-DD hh:mm:ss
  loginDate string アカウントログイン日時が設定されます。
フォーマット:YYYY-MM-DD hh:mm:ss
  passwordExpireDate string アカウントパスワード有効期限が設定されます。
フォーマット:YYYY-MM-DD hh:mm:ss

レスポンス例(正常)

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
401(Unauthorized)
  トークン不正 なし
  パスワードが期限切れもしくは旧式や初期パスワード なし
403(Forbidden)
  アクセス権不正 なし
404(Not Found)
  アカウントID不正 なし
429(Too many requests)
  ロックアウト なし