BatchRemoveRole
Remove role from multiple users or groups in a private re:Post.
Request Syntax
PATCH /spaces/spaceId
/roles HTTP/1.1
Content-type: application/json
{
"accessorIds": [ "string
" ],
"role": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- spaceId
-
The unique ID of the private re:Post.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- accessorIds
-
The user or group accessor identifiers to remove the role from.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
Required: Yes
- role
-
The role to remove from the users or groups.
Type: String
Valid Values:
EXPERT | MODERATOR | ADMINISTRATOR | SUPPORTREQUESTOR
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"errors": [
{
"accessorId": "string",
"error": number,
"message": "string"
}
],
"removedAccessorIds": [ "string" ]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- errors
-
An array of errors that occurred when roles were removed.
Type: Array of BatchError objects
- removedAccessorIds
-
An array of successfully updated accessor identifiers.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
User does not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Unexpected error during processing of request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Request references a resource which does not exist.
HTTP Status Code: 404
- ThrottlingException
-
Request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: