Skip to content
AWS for Query.Farm

aws.finspace_data.list_users_by_permission_group

Example SQL Queries

SELECT * FROM
aws.finspace_data.list_users_by_permission_group
WHERE
"permission_group_id" = 'VALUE'
AND "max_results" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
max_results Required Input Column

The maximum number of results per page.

BIGINT
permission_group_id Required Input Column

The unique identifier for the permission group.

VARCHAR
next_token Input Column

A token that indicates where a results page should begin.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

users

Lists details of all users in a specific permission group.

STRUCT(
    "user_id" VARCHAR,
    "status" VARCHAR,
    "first_name" VARCHAR,
    "last_name" VARCHAR,
    "email_address" VARCHAR,
    "type" VARCHAR,
    "api_access" VARCHAR,
    "api_access_principal_arn" VARCHAR,
    "membership_status" VARCHAR
)[]
Show child fields
users[]
Show child fields
users[].api_access

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.

users[].api_access_principal_arn

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

users[].email_address

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.

users[].first_name

The first name of the user.

users[].last_name

The last name of the user.

users[].membership_status

Indicates the status of the user within a permission group.

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

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

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

users[].status

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.

users[].type

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.

users[].user_id

The unique identifier for the user.