Skip to content
AWS for Query.Farm

aws.identitystore.list_users

Example SQL Queries

SELECT * FROM
aws.identitystore.list_users
WHERE
"identity_store_id" = 'VALUE';

Description

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

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
identity_store_id Required Input Column

The globally unique identifier for the identity store.

VARCHAR
filters Input Column

A list of Filter objects, which is used in the ListUsers and ListGroups requests. 

STRUCT(
    "attribute_path" VARCHAR,
    "attribute_value" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].attribute_path

The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

filters[].attribute_value

Represents the data for an attribute. Each attribute value is described as a name-value pair.

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

A list of Address objects containing addresses associated with the user.

STRUCT(
    "street_address" VARCHAR,
    "locality" VARCHAR,
    "region" VARCHAR,
    "postal_code" VARCHAR,
    "country" VARCHAR,
    "formatted" VARCHAR,
    "type" VARCHAR,
    "primary" BOOLEAN
)[]
Show child fields
addresses[]
Show child fields
addresses[].country

The country of the address.

addresses[].formatted

A string containing a formatted version of the address for display.

addresses[].locality

A string of the address locality.

addresses[].postal_code

The postal code of the address.

addresses[].primary

A Boolean value representing whether this is the primary address for the associated resource.

addresses[].region

The region of the address.

addresses[].street_address

The street of the address.

addresses[].type

A string representing the type of address. For example, "Home."

display_name

A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

VARCHAR
emails

A list of Email objects containing email addresses associated with the user.

STRUCT(
    "value" VARCHAR,
    "type" VARCHAR,
    "primary" BOOLEAN
)[]
Show child fields
emails[]
Show child fields
emails[].primary

A Boolean value representing whether this is the primary email address for the associated resource.

emails[].type

A string representing the type of address. For example, "Work."

emails[].value

A string containing an email address. For example, "johndoe@amazon.com."

external_ids

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

STRUCT(
    "issuer" VARCHAR,
    "id" VARCHAR
)[]
Show child fields
external_ids[]
Show child fields
external_ids[].id

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

external_ids[].issuer

The issuer for an external identifier.

locale

A string containing the geographical region or location of the user.

VARCHAR
name

An object containing the name of the user.

STRUCT(
    "formatted" VARCHAR,
    "family_name" VARCHAR,
    "given_name" VARCHAR,
    "middle_name" VARCHAR,
    "honorific_prefix" VARCHAR,
    "honorific_suffix" VARCHAR
)
Show child fields
name.family_name

The family name of the user.

name.formatted

A string containing a formatted version of the name for display.

name.given_name

The given name of the user.

name.honorific_prefix

The honorific prefix of the user. For example, "Dr."

name.honorific_suffix

The honorific suffix of the user. For example, "M.D."

name.middle_name

The middle name of the user.

nick_name

A string containing an alternate name for the user.

VARCHAR
phone_numbers

A list of PhoneNumber objects containing phone numbers associated with the user.

STRUCT(
    "value" VARCHAR,
    "type" VARCHAR,
    "primary" BOOLEAN
)[]
Show child fields
phone_numbers[]
Show child fields
phone_numbers[].primary

A Boolean value representing whether this is the primary phone number for the associated resource.

phone_numbers[].type

A string representing the type of a phone number. For example, "Mobile."

phone_numbers[].value

A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".

preferred_language

A string containing the preferred language of the user. For example, "American English" or "en-us."

VARCHAR
profile_url

A string containing a URL that might be associated with the user.

VARCHAR
timezone

A string containing the time zone of the user.

VARCHAR
title

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

VARCHAR
user_id

The identifier for a user in the identity store.

VARCHAR
user_name

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

VARCHAR
user_type

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

VARCHAR