List Users
identitystore_list_users | R Documentation |
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 administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.
Usage¶
Arguments¶
IdentityStoreId
[required] The globally unique identifier for the identity store, such as
d-1234567890
. In this example,d-
is a fixed prefix, and1234567890
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
The maximum number of results to be returned per request. This parameter is used in the
list_users
andlist_groups
requests to specify how many results to return in one page. The length limit is 50 characters.NextToken
The pagination token used for the
list_users
andlist_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 search for the next page.Filters
A list of
Filter
objects, which is used in thelist_users
andlist_groups
requests.
Value¶
A list with the following syntax:
list(
Users = list(
list(
UserName = "string",
UserId = "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",
IdentityStoreId = "string"
)
),
NextToken = "string"
)