[ aws . finspace-data ]

list-users-by-permission-group

Description

Lists details of all the users in a specific permission group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-users-by-permission-group
--permission-group-id <value>
[--next-token <value>]
--max-results <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--permission-group-id (string)

The unique identifier for the permission group.

--next-token (string)

A token that indicates where a results page should begin.

--max-results (integer)

The maximum number of results per page.

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

users -> (list)

Lists details of all users in a specific permission group.

(structure)

The structure of a user account associated with a permission group.

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 unique 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 access FinSpace API operations.

• ENABLED – The user has permissions to use the API operations.

• DISABLED – The user does not have permissions to use any API operations.

apiAccessPrincipalArn -> (string)

The IAM ARN identifier that is attached to FinSpace API calls.

membershipStatus -> (string)

Indicates the status of the user account within a permission group.

• ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

• ADDITION_SUCCESS – The user account is successfully added to the permission group.

• REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

nextToken -> (string)

A token that indicates where a results page should begin.