Lists all users in the identity store¶

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 get_user_id API action.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Usage¶

identitystore_list_users(IdentityStoreId, Extensions, MaxResults,
  NextToken, Filters)

Arguments¶

IdentityStoreId

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

You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
Extensions

A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. aws:identitystore:enterprise is the only supported extension name.
MaxResults

The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
NextToken

The pagination token used for the list_users and list_groups 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 retrieve the next page of results.
Filters

A list of Filter objects, which is used in the list_users and list_groups requests.

Value¶

A list with the following syntax:

list(
  Users = list(
    list(
      IdentityStoreId = "string",
      UserId = "string",
      UserArn = "string",
      Revision = "string",
      UserName = "string",
      ExternalIds = list(
        list(
          Issuer = "string",
          Id = "string"
        )
      ),
      Name = list(
        Formatted = "string",
        FamilyName = "string",
        GivenName = "string",
        MiddleName = "string",
        HonorificPrefix = "string",
        HonorificSuffix = "string"
      ),
      DisplayName = "string",
      NickName = "string",
      ProfileUrl = "string",
      Emails = list(
        list(
          Value = "string",
          Type = "string",
          Primary = TRUE|FALSE
        )
      ),
      Addresses = list(
        list(
          StreetAddress = "string",
          Locality = "string",
          Region = "string",
          PostalCode = "string",
          Country = "string",
          Formatted = "string",
          Type = "string",
          Primary = TRUE|FALSE
        )
      ),
      PhoneNumbers = list(
        list(
          Value = "string",
          Type = "string",
          Primary = TRUE|FALSE
        )
      ),
      UserType = "string",
      Title = "string",
      PreferredLanguage = "string",
      Locale = "string",
      Timezone = "string",
      UserStatus = "ENABLED"|"DISABLED",
      Photos = list(
        list(
          Value = "string",
          Type = "string",
          Display = "string",
          Primary = TRUE|FALSE
        )
      ),
      Website = "string",
      Birthdate = "string",
      Roles = list(
        list(
          Value = "string",
          Type = "string",
          Primary = TRUE|FALSE
        )
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = "string",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedBy = "string",
      Extensions = list(
        list()
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_users(
  IdentityStoreId = "string",
  Extensions = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string",
  Filters = list(
    list(
      AttributePath = "string",
      AttributeValue = "string"
    )
  )
)