get_user

FinSpaceData.Client.get_user(**kwargs)

Retrieves details for a specific user.

See also: AWS API Documentation

Request Syntax

response = client.get_user(
    userId='string'
)

Parameters

userId (string) --

[REQUIRED]

The unique identifier of the user to get data for.

Return type

dict

Returns

Response Syntax

{
    'userId': 'string',
    'status': 'CREATING'|'ENABLED'|'DISABLED',
    'firstName': 'string',
    'lastName': 'string',
    'emailAddress': 'string',
    'type': 'SUPER_USER'|'APP_USER',
    'apiAccess': 'ENABLED'|'DISABLED',
    'apiAccessPrincipalArn': 'string',
    'createTime': 123,
    'lastEnabledTime': 123,
    'lastDisabledTime': 123,
    'lastModifiedTime': 123,
    'lastLoginTime': 123
}

Response Structure

• (dict) --
  • userId (string) --

    The unique identifier for the user account that is retrieved.

  • status (string) --

    The current status of the user account.

    • CREATING – The user account creation is in progress.
    • ENABLED – The user account is created and is currently active.
    • DISABLED – The user account is currently inactive.
  • firstName (string) --

    The first name of the user.

  • lastName (string) --

    The last name of the user.

  • emailAddress (string) --

    The email address that is associated with the user.

  • type (string) --

    Indicates 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.
  • apiAccess (string) --

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

  • createTime (integer) --

    The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.

  • lastEnabledTime (integer) --

    Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.

  • lastDisabledTime (integer) --

    Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.

  • lastModifiedTime (integer) --

    Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.

  • lastLoginTime (integer) --

    Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

Exceptions

• FinSpaceData.Client.exceptions.InternalServerException
• FinSpaceData.Client.exceptions.ValidationException
• FinSpaceData.Client.exceptions.ThrottlingException
• FinSpaceData.Client.exceptions.AccessDeniedException
• FinSpaceData.Client.exceptions.ResourceNotFoundException