[ aws . finspace-data ]

list-users

Description

Lists all available user accounts in FinSpace.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-users is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: users

Synopsis

  list-users
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

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

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

users -> (list)

A list of all the user accounts.

(structure)

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 -> (long)

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

lastEnabledTime -> (long)

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

lastDisabledTime -> (long)

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

lastModifiedTime -> (long)

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

lastLoginTime -> (long)

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.