ログインAPI

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

アカウント情報で認証を行い、設計ツールAPIの利用に必要なアクセストークンを払い出すAPIです。

ログインAPI以外のAPIは、払い出されたアクセストークンをHTTPヘッダに設定する必要があります。
また、一定回数連続で不正パスワードを入力するとロックアウトされます。

エンドポイント

URL

https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/login

リクエスト

Method POST
Body JSON形式(詳細はリクエストパラメータを参照)

レスポンス

ステータスコード 成功

  • 200(OK)

エラー

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

URLパラメータ

URLパラメータはありません。

リクエストパラメータ

名称 必須 説明
accountName string アカウント名を指定します。
password string パスワードを指定します。

レスポンスパラメータ

名称 必須 説明
accessToken string 払い出されたアクセストークンが設定されます。
message string 指定したパスワードが期限切れもしくは旧式や初期パスワードの場合、以下のメッセージが設定されます。

  • 旧式パスワード → old-form password
  • 期限切れパスワード → password expired
  • 初期パスワード → initial password

これらのメッセージが設定されている場合、払い出されたアクセストークンは、自分のパスワード変更およびログアウト以外のAPIが利用できません。

レスポンス例(エラー)

HTTPステータス/原因 レスポンス内容
400(Bad Request)
  アカウント名不正 なし
  パスワード不正 なし
403(Forbidden)
  無効アカウントでのログイン なし
429(Too many requests)
  ロックアウト なし