FinSpaceData / Client / disable_user

disable_user#

FinSpaceData.Client.disable_user(**kwargs)#

Denies access to the FinSpace web application and API for the specified user.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.disable_user(
    userId='string',
    clientToken='string'
)
Parameters:

  • userId (string) –

    [REQUIRED]

    The unique identifier for the user that you want to deactivate.

  • clientToken (string) –

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'userId': 'string'
}

Response Structure

  • (dict) –

    • userId (string) –

      The unique identifier for the deactivated user.

Exceptions

  • FinSpaceData.Client.exceptions.InternalServerException

  • FinSpaceData.Client.exceptions.ValidationException

  • FinSpaceData.Client.exceptions.ThrottlingException

  • FinSpaceData.Client.exceptions.AccessDeniedException

  • FinSpaceData.Client.exceptions.ResourceNotFoundException

  • FinSpaceData.Client.exceptions.ConflictException