Users
- Written for
- + Written for
- Deprecated
- + Deprecated
- Applies to
- + Applies to
Users
Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.
12 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.
Method & path | Idem | Explanation |
|---|---|---|
| Search users by email, name or id, filtered by banned, MFA or provider. | |
| Create a user with a verified email and an optional password. Owner or admin. | |
| Full user profile for an administrator, including private metadata. | |
| Ban a user and revoke every session they hold. | |
| Lift a ban. Sessions are not restored. | |
| Clear an automated lockout for a user locked out by guessing. | |
| Remove every second factor. Requires owner or admin. | |
| Sign a user out everywhere and bump sessions_version. | |
| Revoke one of a user’s sessions (per-device sign-out). | |
| Mint a single-use impersonation token. Audited by person. | |
| Soft-delete a user. PII is scrubbed after 30 days. | |
| Edit the public, private and unsafe metadata bags. Refuses non-objects, prototype-polluting keys, oversized and over-nested documents. |