Modify Members¶
POST /api/v1/workspace/member/batch_modify
Overview¶
Modify one/multiple members
Body Request Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| accountUUIDs | array | Y | Account list Example: ['Account UUID1 not in workspace', 'Account UUID2 not in workspace'] Can be empty: True |
| roleUUIDs | array | Y | User role UUID list Example: None Can be empty: False |
| onlyModifyRoles | boolean | Y | Whether to only modify member roles, True does not modify team information Example: True Can be empty: False |
| memberGroupUUIDs | array | Team list Example: ['xxx', 'xxx'] Can be empty: True |
|
| acntWsNickname | string | Nickname of the account in this space Example: NicknameAAA Can be empty: True $maxCustomLength: 128 |
Supplementary Parameter Explanation¶
Data explanation.*
When modifying member roles, if there are roles in roleUUIDs that require Token review (Free Plan for SaaS, PAAS version does not require Billing Center review), then it must include role UUIDs that do not require review.
- Request Parameter Explanation
| Parameter Name | type | Description |
|---|---|---|
| accountUUIDs | list | Member account UUID |
| roleUUIDs | list | Role UUID |
| onlyModifyRoles | boolean | Whether to only change role information (true for batch modification, false for individual modification) |
| memberGroupUUIDs | list | Team information is required when modifying a single member |
| acntWsNickname | string | Account nickname in the workspace |
| ------ |
Request Example¶
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
Response¶
{
"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"
}