List users
Retrieves a paginated list of users. Optional query parameters allow searching, filtering, and sorting the results.
API-KeyX-API-KEY<token>MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>
The page number to retrieve.
int321 <= value1The number of users to return per page.
int321 <= value <= 5010Optional Lucene-style filter expression used to search by attributes.
Sort expression in the format field:direction, where direction is 1 for ascending or -1 for descending.
Supported fields include - failure_count, last_sign_in_attempt, sign_in_attempts_count, last_sign_in_success, sign_in_success_count, last_activity, block_until, creation_time, last_updated.
Response Headers
200
Returns the x-Pagination header
Number of items returned per page.
int32The current page number.
int32Total number of items available.
int32Indicates whether a previous page exists.
Indicates whether a next page exists.
Response Body
application/json
The users were retrieved successfully
TypeScript Definitions
Use the response body type in TypeScript.
Returns an array. Each item has the fields below.
User Summary: A lightweight user representation returned in list operations.
Errors
curl -X GET "https://your-domain.us.monocloud.com/api/users?page=1&size=10&filter=%28name%3Abob+OR+email%3Abob%40example.com%29&sort=creation_time%3A1" \ -H "X-API-KEY: <token>"[ { "user_id": "string", "disabled": true, "claims": { "property1": null, "property2": null }, "emails": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "primary": true, "verified": true, "source": null, "verification_source": null, "email": "string" } ], "phone_numbers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "primary": true, "verified": true, "source": null, "verification_source": null, "phone": "string" } ], "passkeys": [ { "name": null, "passkey_id": "string", "public_key": "string", "aa_guid": "8a066881-0124-4a97-b518-fe03ecf6e108", "backup_state": true, "backup_eligibility": true, "user_present": true, "user_verified": true, "user_agent": "string" } ], "force_password_reset": true, "external_providers": [ { "provider": "string", "authenticator": "google", "provider_user_id": "string" } ], "creation_time": 0, "last_updated": 0, "username": null, "has_password": true, "password_updated_at": null, "block_until": null, "failure_count": 0, "sign_in_attempts_count": 0, "last_sign_in_attempt": null, "last_sign_in_attempt_ip": null, "sign_in_success_count": 0, "last_sign_in_success": null, "last_sign_in_success_ip": null, "last_activity": null, "last_known_city": null, "last_known_country": null, "last_known_region": null }]Delete a claim DELETE
Permanently deletes the specified claim.
Create a user POST
Creates a new user using identifiers such as email, phone number, or username, with an optional password or imported password hash. This endpoint also supports migration scenarios by allowing administrators to preserve verification states and bypass password policies or identifier restrictions when required.