Create an organization

POST /api/organizations
O auth2

Create a new organization with the given data.

application/json

Body Required

  • tenantId string

    Maximum length is 21.

  • name string Required

    The name of the organization.

    Minimum length is 1, maximum length is 128.

  • description string | null

    The description of the organization.

    Maximum length is 256.

  • customData object

    arbitrary

  • isMfaRequired boolean
  • branding object
    Hide branding attributes Show branding attributes object
    • logoUrl string(url)
    • darkLogoUrl string(url)
    • favicon string(url)
    • darkFavicon string(url)
  • createdAt number

Responses

  • 201 application/json

    The organization was created successfully.

    Hide response attributes Show response attributes object
    • tenantId string Required

      Maximum length is 21.

    • id string Required

      Minimum length is 1, maximum length is 21.

    • name string Required

      Minimum length is 1, maximum length is 128.

    • description string | null Required

      Maximum length is 256.

    • customData object Required

      arbitrary

    • isMfaRequired boolean Required
    • branding object Required
      Hide branding attributes Show branding attributes object
      • logoUrl string(url)
      • darkLogoUrl string(url)
      • favicon string(url)
      • darkFavicon string(url)
    • createdAt number Required
  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

POST /api/organizations 
curl \
 --request POST 'https://[tenant_id].logto.app/api/organizations' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"tenantId":"string","name":"string","description":"string","customData":{},"isMfaRequired":true,"branding":{"logoUrl":"string","darkLogoUrl":"string","favicon":"string","darkFavicon":"string"},"createdAt":42.0}'
Request examples 
{
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "customData": {},
  "isMfaRequired": true,
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string",
    "darkFavicon": "string"
  },
  "createdAt": 42.0
}
Response examples (201) 
{
  "tenantId": "string",
  "id": "string",
  "name": "string",
  "description": "string",
  "customData": {},
  "isMfaRequired": true,
  "branding": {
    "logoUrl": "string",
    "darkLogoUrl": "string",
    "favicon": "string",
    "darkFavicon": "string"
  },
  "createdAt": 42.0
}