管理APIリファレンス
アクセス権限：全員
ログイン以外のAPIは、払い出されるアクセストークンをHTTP認証ヘッダパラメータに使用すること。
期限切れもしくは旧式や初期パスワードの場合のアクセストークンは、自分のパスワード変更とログアウト以外のAPIは利用できない。
一定回数連続でパスワードを間違えるとロックアウト(429)
| accountName required | string アカウント名 |
| password required | string パスワード |
ログイン認証成功
BadRequest(アカウント名不正/パスワード不正)
Forbidden(無効なアカウントでのログイン)
Too many requests(ロックアウト)
{- "accountName": "AccountName",
- "password": "password1234"
}{- "accessToken": "NLP XXXXXXXXXXXXXXXXXX",
- "message": "initial password"
}アクセス権限：サーバ管理者以上
| Authorization required | string アクセストークン |
| organizationName required | string <= 100 characters 組織名 |
| address | string <= 100 characters 住所 |
| tel | string <= 32 characters 電話番号 |
Created
Bad Request(組織名不正)
Unauthorized(トークン不正/要パスワード変更アカウント)
Forbidden(アクセス権不正)
Conflict
Too many requests(ロックアウト)
{- "organizationName": "DoCoMo",
- "address": "XXXXXXXX",
- "tel": "01-2345-6789"
}{- "organizationId": 0
}アクセス権限：全員
| Authorization required | string アクセストークン |
OK
Bad Request
Unauthorized(トークン不正/要パスワード変更アカウント)
Too many requests(ロックアウト)
{- "organizations": [
- {
- "organizationId": 1,
- "organizationName": "DoCoMo",
- "address": "XXXXXXX",
- "tel": "01-2345-6789"
}
]
}アクセス権限：テナント管理者以上（テナント管理者は所属しているテナントのみ）
| organizationId required | integer 組織ID |
| Authorization required | string アクセストークン |
最低1つのキー必須
| organizationName | string <= 100 characters 組織名 |
| address | string <= 100 characters 住所 |
| tel | string <= 32 characters 電話番号 |
No Content
Bad Request(キー未指定)
Unauthorized(トークン不正/要パスワード変更アカウント)
Forbidden(アクセス権不正)
Not Found(組織ID不正)
Method Not Allowed
Conflict
Too many requests(ロックアウト)
{- "organizationName": "DoCoMo",
- "address": "XXXXXXXX",
- "tel": "01-2345-6789"
}アクセス権限：サーバ管理者以上
| organizationId required | integer 組織ID |
| Authorization required | string アクセストークン |
No Content
Unauthorized(トークン不正/要パスワード変更アカウント)
Forbidden(アクセス権不正)
Not Found(組織ID不正)
Method Not Allowed
Too many requests(ロックアウト)
アクセス権限：全員
| organizationId required | integer 組織ID |
| Authorization required | string アクセストークン |
OK
Bad Request
Unauthorized(トークン不正/要パスワード変更アカウント)
Forbidden(アクセス権不正)
Not Found(組織ID不正)
Too many requests(ロックアウト)
{- "organizationId": 1,
- "organizationName": "DoCoMo",
- "address": "XXXXXXX",
- "tel": "01-2345-6789"
}アクセス権限：テナント管理者以上（テナント管理者は所属している組織のみ）
| organizationId required | integer 組織ID |
| Authorization required | string アクセストークン |
| accountIds required | Array of objects アカウントID一覧 |
Created
Bad Request(アカウントID不正)
Unauthorized(トークン不正/要パスワード変更アカウント)
Forbidden(アクセス権不正)
Not Found(組織ID不正)
Too many requests(ロックアウト)
{- "accountIds": [
- {
- "accountId": 1
}
]
}アクセス権限：テナント管理者以上（テナント管理者は所属している組織のみ）
| organizationId required | integer 組織ID |
| Authorization required | string アクセストークン |
OK
Bad Request
Unauthorized(トークン不正/要パスワード変更アカウント)
Forbidden(アクセス権不正)
Not Found(組織ID不正)
Too many requests(ロックアウト)
{- "accountIds": [
- {
- "accountId": 1
}
]
}アクセス権限：テナント管理者以上（テナント管理者は所属している組織のみ）
| organizationId required | integer 組織ID |
| accountId required | integer アカウントID、カンマ区切りで複数指定可能 |
| Authorization required | string アクセストークン |
No Content
Bad Request
Unauthorized(トークン不正/要パスワード変更アカウント)
Forbidden(アクセス権不正)
Not Found(アカウントID不正/組織ID不正)
Method Not Allowed
Too many requests(ロックアウト)
アクセス権限：テナント管理者以上（テナント管理者は所属している組織のみ）
| Authorization required | string アクセストークン |
| accountName required | string <= 180 characters アカウント名 |
| password required | string [ 8 .. 180 ] characters パスワード アカウント名と異なる値とすること 英・数・記号の2つ以上を組み合わせること |
| description | string <= 100 characters 表示名 |
| authorization required | integer [ 0 .. 4 ] アクセス権。登録者以上のアクセス権は設定できない。アクセス権については以下のとおり
|
| enable | boolean アカウント利用可否フラグ。未指定の場合、true |
| eternity | boolean 2.6.3以降 パスワード有効期限を無期限（2038年まで有効) にする。(特権・サーバ管理者のみ指定可能)。 未指定の場合、false |
Created
Bad Request(アカウント名不正/パスワード強度不足/指定アクセス権不正/有効フラグ不正)
Unauthorized(トークン不正/要パスワード変更アカウント)
Forbidden(アクセス権不正)
Conflict
Too many requests(ロックアウト)
{- "accountName": "DoCoMoUser",
- "password": "password1234",
- "description": "ドコモ",
- "authorization": 1,
- "enable": true,
- "eternity": false
}{- "accountId":