rePostPrivate / Client / batch_remove_role

batch_remove_role¶

rePostPrivate.Client.batch_remove_role(**kwargs)¶

Remove a role from multiple users or groups in a private re:Post.

Request Syntax

response = client.batch_remove_role(
    spaceId='string',
    accessorIds=[
        'string',
    ],
    role='EXPERT'|'MODERATOR'|'ADMINISTRATOR'|'SUPPORTREQUESTOR'
)

Parameters:

spaceId (string) –
[REQUIRED]

The unique ID of the private re:Post.
accessorIds (list) –
[REQUIRED]

The user or group accessor identifiers to remove the role from.
- (string) –
role (string) –
[REQUIRED]

The role to remove from the users or groups.

Return type:

dict

Returns:

Response Syntax

{
    'removedAccessorIds': [
        'string',
    ],
    'errors': [
        {
            'accessorId': 'string',
            'error': 123,
            'message': 'string'
        },
    ]
}

Response Structure

(dict) –
- removedAccessorIds (list) –
  
  An array of successfully updated accessor identifiers.
  - (string) –
- errors (list) –
  
  An array of errors that occurred when roles were removed.
  - (dict) –
    
    An error that occurred during a batch operation.
    - accessorId (string) –
      
      The accessor identifier that’s related to the error.
    - error (integer) –
      
      The error code.
    - message (string) –
      
      Description of the error.

Exceptions

rePostPrivate.Client.exceptions.ValidationException
rePostPrivate.Client.exceptions.AccessDeniedException
rePostPrivate.Client.exceptions.ResourceNotFoundException
rePostPrivate.Client.exceptions.ThrottlingException
rePostPrivate.Client.exceptions.InternalServerException