users

QUERY

Returns users.

Arguments

user_poolRequired

UserPool

The user pool to query. One of the following: MERCHANT, SYSTEM, PARTNER.

Values

MERCHANTPARTNERSYSTEM

merchant_uid

String

The merchant uid to query users for. Only used when querying users in the Merchant and System Portal.

Response

ArrayUser

email

String| null

The email address of the user.

full_name

String| null

The full name of the user.

phone

String| null

The phone number of the user.

user_status

String| null

The status of the user. Likely to be one of the following: CONFIRMED, FORCE_CHANGE_PASSWORD

username

String| null

The cognito username id of the user.