Make an org
Makes an org with its default brand, and makes the caller its owner. Only a person can: an API key acts in its own org. It wants a verified email address (`email_unverified`). Where Synq isn't open for sign-up, only the people it lets in can (`org_creation_closed`), and one person owns a limited number of orgs (`org_quota_exceeded`). Recorded as `org.created`.
/v1/orgsMakes an org with its default brand, and makes the caller its owner. Only a person can: an API key acts in its own org. It wants a verified email address (email_unverified). Where Synq isn't open for sign-up, only the people it lets in can (org_creation_closed), and one person owns a limited number of orgs (org_quota_exceeded). Recorded as org.created.
Authorization
bearer An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/orgs" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "slug": "string" }'{ "id": "string", "slug": "string", "name": "string", "default_brand_id": "string", "plan": "string", "created_at": "2019-08-24T14:15:22Z", "disabled_at": "2019-08-24T14:15:22Z", "disabled_reason": "string"}Hand the org over POST
The owner makes another member the owner, and becomes an admin. Needs `org.ownership.transfer`, which only the owner has, as a person who signed in within the last 5 minutes (`max_age=300`). It refuses a member who owns as many orgs as one person may (`recipient_org_quota_exceeded`). Recorded as `org.ownership_transferred`.
Remove a user's passkey DELETE
It stops signing them in at once, even when it was their last way to sign in: a stolen device's passkey has to be removable, and the tenant decides what comes next (another way in, or disabling the user). Sessions it signed in keep going: end them with `revoke-sessions`. Needs `org.users.edit`. Recorded as `user.passkey_removed`, `by: management_api`.