[ aws . finspace-data ]

get-user

Description

Retrieves details for a specific user.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-user
--user-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--user-id (string)

The unique identifier of the user to get data for.

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

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

See ‘aws help’ for descriptions of global parameters.

Output

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