FinSpaceData / Client / update_user

update_user#

FinSpaceData.Client.update_user(**kwargs)#

Modifies the details of the specified user. You cannot update the userId for a 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.update_user(
    userId='string',
    type='SUPER_USER'|'APP_USER',
    firstName='string',
    lastName='string',
    apiAccess='ENABLED'|'DISABLED',
    apiAccessPrincipalArn='string',
    clientToken='string'
)
Parameters:

  • userId (string) –

    [REQUIRED]

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

  • type (string) –

    The option to indicate the type of user.

    • SUPER_USER– A user with permission to all the functionality and data in FinSpace.

    • APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

  • firstName (string) – The first name of the user.

  • lastName (string) – The last name of the user.

  • apiAccess (string) –

    The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

    • ENABLED – The user has permissions to use the APIs.

    • DISABLED – The user does not have permissions to use any APIs.

  • apiAccessPrincipalArn (string) – The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

  • 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 of the updated 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