rePostPrivate / Client / batch_remove_role

batch_remove_role#

rePostPrivate.Client.batch_remove_role(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • 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.

  • spaceId (string) –

    [REQUIRED]

    The unique ID of the private re:Post.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • 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.

    • removedAccessorIds (list) –

      An array of successfully updated accessor identifiers.

      • (string) –

Exceptions