Organizations
- Written for
- + Written for
- Deprecated
- + Deprecated
- Applies to
- + Applies to
Organizations
Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.
21 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.
Method & path | Idem | Explanation |
|---|---|---|
| List or search organizations, with member counts and the O4 orphaned flag. | |
| Create an organization in this instance. Starts adminless until its first invite. | |
| One organization with its members and its full invitation history. | |
| Delete an organization. The O4 remedy; requires owner or admin. | |
| Clone an org's config (name, slug, policy, email domains, groups + role grants — not members) into the application's other environment (prod↔test). | |
| Add an existing user of this instance to an organization (O5 enforced). | |
| Change a member's role. Demoting the last admin is 409 LAST_ADMIN (O1). | |
| Remove a member. Removing the last admin is 409 LAST_ADMIN (O1). | |
| List the organization directory groups, so a role grant can pick one. | |
| Read the org security policy (requireMfa, ssoRequired, sessionIdleOverrideMs). | |
| Update the org security policy (requireMfa, ssoRequired, sessionIdleOverrideMs). | |
| List the org roles granted to a directory group. | |
| Grant an org role to a directory group; members inherit its permissions. | |
| Revoke a role from a directory group. | |
| Issue an invitation with no member behind it; the audit row names the operator. | |
| Revoke a pending invitation. Already-accepted ones are 409. | |
| List an organization email domains and their verification state. | |
| Claim an email domain for auto-join. Returns the DNS TXT record to publish. | |
| Check the DNS TXT record now and mark the domain verified. | |
| Update a claimed domain auto-join and default role. The domain and its verification state are immutable. | |
| Remove a claimed email domain. |