組織メンバーの一覧を取得するAPIです。
エンドポイント
URL
https://sunaba.xaiml.docomo-dialog.com/NLPManagementAPI/organizations/{organizationId}/members |
リクエスト
Method | GET |
|
---|---|---|
Header | Authorization |
ログインAPIで払い出したアクセストークンを指定します。 |
Body | なし |
レスポンス
ステータスコード | 成功
エラー
|
---|---|
Body | 成功:JSON 形式 エラー:なし |
URLパラメータ
パラメータ名 | 説明 |
---|---|
organizationId |
組織メンバーを取得する対象の組織IDを指定します。 |
リクエストパラメータ
リクエストパラメータはありません。
レスポンスパラメータ
キー | 型 | 必須 | 説明 | |
---|---|---|---|---|
accountIds |
object 配列 |
– | 組織メンバーのアカウントIDが配列で設定されます。 | |
accountId |
integer |
– | 組織メンバーのアカウントIDが設定されます。 |
レスポンス例(正常)
1 2 3 4 5 6 7 |
{ "accountIds": [ {"accountId": xx}, {"accountId": xx} … ] } |
レスポンス例(エラー)
HTTPステータス/原因 | レスポンス内容 | |
---|---|---|
401 (Unauthorized) |
||
トークン不正 | なし | |
パスワードが期限切れもしくは旧式や初期パスワード | なし | |
403 (Forbidden) |
||
アクセス権不正 | なし | |
404 (Not Found) |
||
組織ID不正 | なし | |
429 (Too many requests) |
||
ロックアウト | なし |