Create a user
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.
Configured sign-up policies are enforced by default; however, this allows authorized requests to override them when permitted.
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>
Request Body
application/json
The request payload used to create a user.
TypeScript Definitions
Use the request body type in TypeScript.
Create User Request: Fields used to create a new user and optionally set identifiers, credentials, and profile attributes.
Response Headers
201
Returns the location header
uriResponse Body
application/json
The user was created successfully
TypeScript Definitions
Use the response body type in TypeScript.
User: Represents a user account returned by the operation.
Errors
curl -X POST "https://your-domain.us.monocloud.com/api/users" \ -H "X-API-KEY: <token>" \ -H "Content-Type: application/json" \ -d '{}'{ "user_id": "string", "disabled": true, "claims": { "property1": null, "property2": null }, "public_data": { "property1": null, "property2": null }, "private_data": { "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", "claims": { "property1": null, "property2": null } } ], "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}