IdentityStore / Client / list_users

list_users#

IdentityStore.Client.list_users(**kwargs)#

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.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    IdentityStoreId='string',
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'AttributePath': 'string',
            'AttributeValue': 'string'
        },
    ]
)
Parameters:

  • IdentityStoreId (string) –

    [REQUIRED]

    The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

  • MaxResults (integer) – The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

  • NextToken (string) – The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

  • Filters (list) –

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

    • (dict) –

      A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.

      • AttributePath (string) – [REQUIRED]

        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.

      • AttributeValue (string) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Users': [
        {
            'UserName': 'string',
            'UserId': 'string',
            'ExternalIds': [
                {
                    'Issuer': 'string',
                    'Id': 'string'
                },
            ],
            'Name': {
                'Formatted': 'string',
                'FamilyName': 'string',
                'GivenName': 'string',
                'MiddleName': 'string',
                'HonorificPrefix': 'string',
                'HonorificSuffix': 'string'
            },
            'DisplayName': 'string',
            'NickName': 'string',
            'ProfileUrl': 'string',
            'Emails': [
                {
                    'Value': 'string',
                    'Type': 'string',
                    'Primary': True|False
                },
            ],
            'Addresses': [
                {
                    'StreetAddress': 'string',
                    'Locality': 'string',
                    'Region': 'string',
                    'PostalCode': 'string',
                    'Country': 'string',
                    'Formatted': 'string',
                    'Type': 'string',
                    'Primary': True|False
                },
            ],
            'PhoneNumbers': [
                {
                    'Value': 'string',
                    'Type': 'string',
                    'Primary': True|False
                },
            ],
            'UserType': 'string',
            'Title': 'string',
            'PreferredLanguage': 'string',
            'Locale': 'string',
            'Timezone': 'string',
            'IdentityStoreId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Users (list) –

      A list of User objects in the identity store.

      • (dict) –

        A user object that contains the metadata and attributes for a specified user.

        • UserName (string) –

          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.

        • UserId (string) –

          The identifier for a user in the identity store.

        • ExternalIds (list) –

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

          • (dict) –

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

            • Issuer (string) –

              The issuer for an external identifier.

            • Id (string) –

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

        • Name (dict) –

          An object containing the name of the user.

          • Formatted (string) –

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

          • FamilyName (string) –

            The family name of the user.

          • GivenName (string) –

            The given name of the user.

          • MiddleName (string) –

            The middle name of the user.

          • HonorificPrefix (string) –

            The honorific prefix of the user. For example, “Dr.”

          • HonorificSuffix (string) –

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

        • DisplayName (string) –

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

        • NickName (string) –

          A string containing an alternate name for the user.

        • ProfileUrl (string) –

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

        • Emails (list) –

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

          • (dict) –

            The email address associated with the user.

            • Value (string) –

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

            • Type (string) –

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

            • Primary (boolean) –

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

        • Addresses (list) –

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

          • (dict) –

            The address associated with the specified user.

            • StreetAddress (string) –

              The street of the address.

            • Locality (string) –

              A string of the address locality.

            • Region (string) –

              The region of the address.

            • PostalCode (string) –

              The postal code of the address.

            • Country (string) –

              The country of the address.

            • Formatted (string) –

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

            • Type (string) –

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

            • Primary (boolean) –

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

        • PhoneNumbers (list) –

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

          • (dict) –

            The phone number associated with the user.

            • Value (string) –

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

            • Type (string) –

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

            • Primary (boolean) –

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

        • UserType (string) –

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

        • Title (string) –

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

        • PreferredLanguage (string) –

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

        • Locale (string) –

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

        • Timezone (string) –

          A string containing the time zone of the user.

        • IdentityStoreId (string) –

          The globally unique identifier for the identity store.

    • NextToken (string) –

      The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

Exceptions