Create an Organization (admin / Embed-partner)

post

https://api.wingspan.app/v3/platform/organizations

Creates an Organization with optional SSO configuration and attribute mapping. Organization names must be unique. Domains must be verified with the returned DNS token before SSO logins are enabled. Duplicate externalId values return 409 ResourceConflict; create is not an upsert.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for POST /v3/platform/organizations. Admin-only / Embed-partner-only.

externalId

string

Caller's own ID for reconciliation.

name

string

required

Human-readable Organization name (must be unique).

domain

string

required

Primary domain associated with the Organization. Must pass DNS verification (_wingspan-verify.{domain} TXT record) before SSO logins go live.

ssoConfig

object

SSO/IdP configuration for the Organization.

policy

object

Organization-level policy controls.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Organization created

401Unauthenticated

403Forbidden

409Conflict

422Validation error

501This operation is not yet available