FinSpaceData / Client / list_users

list_users#

FinSpaceData.Client.list_users(**kwargs)#

Lists all available users in FinSpace.

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.list_users(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – A token that indicates where a results page should begin.

  • maxResults (integer) –

    [REQUIRED]

    The maximum number of results per page.

Return type:

dict

Returns:

Response Syntax

{
    'users': [
        {
            '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
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • users (list) –

      A list of all the users.

      • (dict) –

        The details of the user.

        • userId (string) –

          The unique identifier for the user.

        • status (string) –

          The current status of the user.

          • CREATING – The user creation is in progress.

          • ENABLED – The user is created and is currently active.

          • DISABLED – The user is currently inactive.

        • firstName (string) –

          The first name of the user.

        • lastName (string) –

          The last name of the user.

        • emailAddress (string) –

          The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it’s created.

        • 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 was created in FinSpace. The value is determined as epoch time in milliseconds.

        • lastEnabledTime (integer) –

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

        • lastDisabledTime (integer) –

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

        • lastModifiedTime (integer) –

          Describes the last time the user 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.

    • nextToken (string) –

      A token that indicates where a results page should begin.

Exceptions