FinSpaceData / Paginator / ListUsers

ListUsers#

class FinSpaceData.Paginator.ListUsers#

paginator = client.get_paginator('list_users')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from FinSpaceData.Client.list_users().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

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 user accounts.
  - (dict) –
    
    The details of the user account.
    - userId (string) –
      
      The unique identifier for the user.
    - 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 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 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.
- NextToken (string) –
  
  A token to resume pagination.