FinSpaceData / Client / reset_user_password

reset_user_password

FinSpaceData.Client.reset_user_password(**kwargs)

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

See also: AWS API Documentation

Request Syntax

response = client.reset_user_password(
    userId='string',
    clientToken='string'
)

Parameters:

• userId (string) –

  [REQUIRED]

  The unique identifier of the user that a temporary password is requested for.

• 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',
    'temporaryPassword': 'string'
}

Response Structure

• (dict) –

  • userId (string) –

    The unique identifier of the user that a new password is generated for.

  • temporaryPassword (string) –

    A randomly generated temporary password for the requested user account. This password expires in 7 days.

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