Skip to main content
POST
auth.organization.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
name
string
required

Organization name, up to 256 characters.

Required string length: 1 - 256
slug
string

Short URL-safe name: lowercase letters, digits and dashes. Derived from the name when omitted.

Required string length: 1 - 64
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
createdByUserId
string

User who becomes the first admin, where the auth system supports it.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

organizationId
string
required

The organization's id.

name
string
required

Organization name.

slug
string

Short URL-safe name.

imageUrl
string

Logo image URL.

createdAt
string

When the organization was created, ISO 8601.

membersCount
number

Number of members.