Create User
This section allows users to create new user profiles within the Mainstay User Service API. By providing essential user information and attributes, users can add individuals to the user pool efficiently.
This functionality streamlines onboarding new users and managing their access within the system.
Header Parameters
x-api-key
string
API key for authentication.
Content-Type
string
The type of content in the request.
Query Parameters
PaginationToken
string
Token used for pagination of results.
Body Parameters
UserPoolId
string
The ID of the user pool.
Username
string
The username of the user.
DesiredDeliveryMediums
array
Array of delivery medium strings, such as EMAIL or SMS. The example request uses an empty array.
MessageAction
string
Action to be taken on the message.
TemporaryPassword
string
Temporary password for the user.
UserAttributes
array
Array of objects with Name and Value string fields, for example { "Name": "email", "Value": "user@example.com" }.
List Users
The List Users section of the MainstayUserServiceAPI allows users to retrieve a list of users based on specified criteria.
Users can access information such as attributes, filters, and limits to customize the results according to their needs.
Header Parameters
x-api-key
string
The API key used for authentication and authorization purposes.
Content-Type
string
Indicates the media type of the request content, typically set to application/json.
Body Parameters
AttributesToGet
array
Array of attribute-name strings to return for each user, for example ["email", "sub"].
Filter
string
Allows filtering the list of users based on specific criteria.
Limit
number
Sets a limit on the number of users to be returned in the list.
UserPoolId
string
Identifies the user pool from which to list users.