Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Lists the users in the specified group.
Calling this action requires developer credentials.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "GroupName": "string",
    "Limit": 0,
    "NextToken": "string"
}'
Response Response Example
200 - Example 1
{
    "Users": [],
    "NextToken": "string"
}

Request

Query Params
Limit
string 
optional
Pagination limit
NextToken
string 
optional
Pagination token
Header Params
X-Amz-Target
string 
required
Body Params application/json
UserPoolId
string 
required
The user pool ID for the user pool.
>= 1 characters<= 55 characters
Match pattern:
[\w-]+_[0-9a-zA-Z]+
GroupName
string 
required
The name of the group.
>= 1 characters<= 128 characters
Match pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Limit
integer 
optional
The limit of the request to list users.
>= 0<= 60
NextToken
string 
optional
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
>= 1 characters
Match pattern:
[\S]+
Examples

Responses

🟢200Success
application/json
Body
Users
array[object (UserType) {7}] 
optional
The users returned in the request to list users.
Username
string <password>
optional
The user name of the user you want to describe.
>= 1 characters<= 128 characters
Match pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Attributes
array[object (AttributeType) {2}] 
optional
A container with information about the user type attributes.
UserCreateDate
string <date-time>
optional
The creation date of the user.
UserLastModifiedDate
string <date-time>
optional
The last modified date of the user.
Enabled
boolean 
optional
Specifies whether the user is enabled.
UserStatus
enum<string> 
optional
The user status. This can be one of the following:
  • UNCONFIRMED - User has been created but not confirmed.
  • CONFIRMED - User has been confirmed.
  • EXTERNAL_PROVIDER - User signed in with a third-party IdP.
  • ARCHIVED - User is no longer active.
  • UNKNOWN - User status isn't known.
  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
  • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
Allowed values:
UNCONFIRMEDCONFIRMEDARCHIVEDCOMPROMISEDUNKNOWNRESET_REQUIREDFORCE_CHANGE_PASSWORD
MFAOptions
array[object (MFAOptionType) {2}] 
optional
The MFA options for the user.
NextToken
string 
optional
An identifier that you can use in a later request to return the next set of items in the list.
>= 1 characters
Match pattern:
[\S]+
🟠480InvalidParameterException
🟠481ResourceNotFoundException
🟠482TooManyRequestsException
🟠483NotAuthorizedException
🟠484InternalErrorException
Modified at 2023-08-15 07:11:07
Previous
/
Next
/
Built with