メンバー修正¶
POST /api/v1/workspace/member/batch_modify
概要¶
1人または複数のメンバーを修正します。
Body リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| accountUUIDs | array | Y | アカウントリスト 例: ['未加入工作空间的账号 UUID1', '未加入工作空间的账号 UUID2'] 空を許可: True |
| roleUUIDs | array | Y | ユーザーロール UUID リスト 例: None 空を許可: False |
| onlyModifyRoles | boolean | Y | メンバーロールのみを変更するかどうか。True の場合はチーム情報を変更しません。 例: True 空を許可: False |
| memberGroupUUIDs | array | チームリスト 例: ['xxx', 'xxx'] 空を許可: True |
|
| acntWsNickname | string | ワークスペースにおけるアカウントのニックネーム 例: ニックネーム AAA 空を許可: True $maxCustomLength: 128 |
パラメーター補足説明¶
データ説明.*
メンバーロールを変更する場合、roleUUIDs に Token 承認が必要なロール（SaaS 無料プラン、PaaS プランでは請求センターの承認は不要）が含まれている場合は、承認が不要なロールの UUID も必ず含める必要があります。
- リクエストパラメーターの説明
| パラメーター名 | type | 説明 |
|---|---|---|
| accountUUIDs | list | メンバーアカウント UUID |
| roleUUIDs | list | ロール UUID |
| onlyModifyRoles | boolean | ロール情報のみを変更するかどうか（true: 一括変更、false: 個別変更） |
| memberGroupUUIDs | list | 個別にメンバーを変更する場合はチーム情報が必須 |
| acntWsNickname | string | ワークスペースにおけるアカウントのニックネーム |
| ------ |
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/workspace/member/batch_modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"accountUUIDs": ["acnt_xxxx32"], "onlyModifyRoles": true, "roleUUIDs": ["general","wsAdmin"]}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"autoLoginUrl": "http://testing-zc-portal.cloudflux.cn/#/signin?from=http:%2F%2Ftesting-zc-portal.cloudflux.cn%2Fportal.html%23%2Finfo%2Flist&ticket=7d628f01-6c63-454a-8cf7-7c30678a9b0d"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-F0E7FBC3-3A2B-4843-9B5E-DAD070AB812B"
}