Skip to content
AWS for Query.Farm

aws.identitystore.get_user_id

Example SQL Queries

SELECT * FROM
aws.identitystore.get_user_id
WHERE
"identity_store_id" = 'VALUE'
AND "alternate_identifier" = 'VALUE';

Description

Retrieves the UserId in an identity store.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Table Definition

Column NameColumn Data Type
alternate_identifier Required Input Column

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are userName and emails.value.

STRUCT(
    "external_id" STRUCT(
        "issuer" VARCHAR,
        "id" VARCHAR
    ),
    "unique_attribute" STRUCT(
        "attribute_path" VARCHAR,
        "attribute_value" VARCHAR
    )
)
Show child fields
alternate_identifier.external_id

The identifier issued to this resource by an external identity provider.

Show child fields
alternate_identifier.external_id.id

The identifier issued to this resource by an external identity provider.

alternate_identifier.external_id.issuer

The issuer for an external identifier.

alternate_identifier.unique_attribute

An entity attribute that's unique to a specific entity.

Show child fields
alternate_identifier.unique_attribute.attribute_path

A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

alternate_identifier.unique_attribute.attribute_value

The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.

identity_store_id Required Input Column

The globally unique identifier for the identity store.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
user_id

The identifier for a user in the identity store.

VARCHAR