管理APIリファレンス (2.6)

管理APIリファレンス

認証

ログイン

アクセス権限:全員

ログイン以外のAPIは、払い出されるアクセストークンをHTTP認証ヘッダパラメータに使用すること。

期限切れもしくは旧式や初期パスワードの場合のアクセストークンは、自分のパスワード変更とログアウト以外のAPIは利用できない。

一定回数連続でパスワードを間違えるとロックアウト(429)

Request Body schema: application/json
accountName
required
string

アカウント名

password
required
string

パスワード

Responses

200

ログイン認証成功

400

BadRequest(アカウント名不正/パスワード不正)

403

Forbidden(無効なアカウントでのログイン)

429

Too many requests(ロックアウト)

post /login
https://management-api.xaiml.docomo-dialog.com/login

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "accountName": "AccountName",
  • "password": "password1234"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "accessToken": "NLP XXXXXXXXXXXXXXXXXX",
  • "message": "initial password"
}

ログアウト

アクセス権限:全員

header Parameters
Authorization
required
string

アクセストークン

Responses

200

OK

400

BadRequest(認証ヘッダなし/トークン不正)

get /logout
https://management-api.xaiml.docomo-dialog.com/logout

組織管理

登録

アクセス権限:サーバ管理者以上

header Parameters
Authorization
required
string

アクセストークン

Request Body schema: application/json
organizationName
required
string <= 100 characters

組織名

address
string <= 100 characters

住所

tel
string <= 32 characters

電話番号

Responses

201

Created

400

Bad Request(組織名不正)

401

Unauthorized(トークン不正/要パスワード変更アカウント)

403

Forbidden(アクセス権不正)

409

Conflict

429

Too many requests(ロックアウト)

post /organizations
https://management-api.xaiml.docomo-dialog.com/organizations

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organizationName": "DoCoMo",
  • "address": "XXXXXXXX",
  • "tel": "01-2345-6789"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organizationId": 0
}

一覧の取得

アクセス権限:全員

header Parameters
Authorization
required
string

アクセストークン

Responses

200

OK

400

Bad Request

401

Unauthorized(トークン不正/要パスワード変更アカウント)

429

Too many requests(ロックアウト)

get /organizations
https://management-api.xaiml.docomo-dialog.com/organizations

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organizations":
    [
    ]
}

更新

アクセス権限:テナント管理者以上(テナント管理者は所属しているテナントのみ)

path Parameters
organizationId
required
integer

組織ID

header Parameters
Authorization
required
string

アクセストークン

Request Body schema: application/json

最低1つのキー必須

organizationName
string <= 100 characters

組織名

address
string <= 100 characters

住所

tel
string <= 32 characters

電話番号

Responses

204

No Content

400

Bad Request(キー未指定)

401

Unauthorized(トークン不正/要パスワード変更アカウント)

403

Forbidden(アクセス権不正)

404

Not Found(組織ID不正)

405

Method Not Allowed

409

Conflict

429

Too many requests(ロックアウト)

put /organizations/{organizationId}
https://management-api.xaiml.docomo-dialog.com/organizations/{organizationId}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organizationName": "DoCoMo",
  • "address": "XXXXXXXX",
  • "tel": "01-2345-6789"
}

削除

アクセス権限:サーバ管理者以上

path Parameters
organizationId
required
integer

組織ID

header Parameters
Authorization
required
string

アクセストークン

Responses

204

No Content

401

Unauthorized(トークン不正/要パスワード変更アカウント)

403

Forbidden(アクセス権不正)

404

Not Found(組織ID不正)

405

Method Not Allowed

429

Too many requests(ロックアウト)

delete /organizations/{organizationId}
https://management-api.xaiml.docomo-dialog.com/organizations/{organizationId}

組織情報の取得

アクセス権限:全員

path Parameters
organizationId
required
integer

組織ID

header Parameters
Authorization
required
string

アクセストークン

Responses

200

OK

400

Bad Request

401

Unauthorized(トークン不正/要パスワード変更アカウント)

403

Forbidden(アクセス権不正)

404

Not Found(組織ID不正)

429

Too many requests(ロックアウト)

get /organizations/{organizationId}
https://management-api.xaiml.docomo-dialog.com/organizations/{organizationId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "organizationId": 1,
  • "organizationName": "DoCoMo",
  • "address": "XXXXXXX",
  • "tel": "01-2345-6789"
}

組織メンバー管理

登録

アクセス権限:テナント管理者以上(テナント管理者は所属している組織のみ)

path Parameters
organizationId
required
integer

組織ID

header Parameters
Authorization
required
string

アクセストークン

Request Body schema: application/json
accountIds
required
Array of objects

アカウントID一覧

Responses

201

Created

400

Bad Request(アカウントID不正)

401

Unauthorized(トークン不正/要パスワード変更アカウント)

403

Forbidden(アクセス権不正)

404

Not Found(組織ID不正)

429

Too many requests(ロックアウト)

post /organizations/{organizationId}/members
https://management-api.xaiml.docomo-dialog.com/organizations/{organizationId}/members

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "accountIds":
    [
    ]
}

一覧の取得

アクセス権限:テナント管理者以上(テナント管理者は所属している組織のみ)

path Parameters
organizationId
required
integer

組織ID

header Parameters
Authorization
required
string

アクセストークン

Responses

200

OK

400

Bad Request

401

Unauthorized(トークン不正/要パスワード変更アカウント)

403

Forbidden(アクセス権不正)

404

Not Found(組織ID不正)

429

Too many requests(ロックアウト)

get /organizations/{organizationId}/members
https://management-api.xaiml.docomo-dialog.com/organizations/{organizationId}/members

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "accountIds":
    [
    ]
}

削除

アクセス権限:テナント管理者以上(テナント管理者は所属している組織のみ)

path Parameters
organizationId
required
integer

組織ID

accountId
required
integer

アカウントID、カンマ区切りで複数指定可能

header Parameters
Authorization
required
string

アクセストークン

Responses

204

No Content

400

Bad Request

401

Unauthorized(トークン不正/要パスワード変更アカウント)

403

Forbidden(アクセス権不正)

404

Not Found(アカウントID不正/組織ID不正)

405

Method Not Allowed

429

Too many requests(ロックアウト)

delete /organizations/{organizationId}/members/{accountId}
https://management-api.xaiml.docomo-dialog.com/organizations/{organizationId}/members/{accountId}

アカウント管理

登録

アクセス権限:テナント管理者以上(テナント管理者は所属している組織のみ)

header Parameters
Authorization
required
string

アクセストークン

Request Body schema: application/json
accountName
required
string <= 180 characters

アカウント名

password
required
string [ 8 .. 180 ] characters

パスワード

アカウント名と異なる値とすること

英・数・記号の2つ以上を組み合わせること

description
string <= 100 characters

表示名

authorization
required
integer [ 0 .. 4 ]

アクセス権。登録者以上のアクセス権は設定できない。アクセス権については以下のとおり

  • 0:特権
  • 1:サーバ管理者
  • 2:テナント管理者
  • 3:シナリオ設計者
  • 4:AIML編集者
enable
boolean

アカウント利用可否フラグ。未指定の場合、true

eternity
boolean

2.6.3以降

パスワード有効期限を無期限(2038年まで有効) にする。(特権・サーバ管理者のみ指定可能)。

未指定の場合、false

Responses

201

Created

400

Bad Request(アカウント名不正/パスワード強度不足/指定アクセス権不正/有効フラグ不正)

401

Unauthorized(トークン不正/要パスワード変更アカウント)

403

Forbidden(アクセス権不正)

409

Conflict

429

Too many requests(ロックアウト)

post /accounts
https://management-api.xaiml.docomo-dialog.com/accounts

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "accountName": "DoCoMoUser",
  • "password": "password1234",
  • "description": "ドコモ",
  • "authorization": 1,
  • "enable": true,
  • "eternity": false
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "accountId":