Create an organization scope

POST /api/organization-scopes

OAuth2

Create a new organization scope with the given data.

application/json

Body Required

tenantId string

Maximum length is 21.
name string Required

The name of the organization scope. It must be unique within the organization template.

Minimum length is 1, maximum length is 128.
description string | null

The description of the organization scope.

Maximum length is 256.

Responses

201 application/json

The organization scope 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.
400

Bad Request
401

Unauthorized
403

Forbidden
422

The organization scope name is already in use.

POST /api/organization-scopes

curl \
 -X POST https://[tenant_id].logto.app/api/organization-scopes \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"tenantId":"string","name":"string","description":"string"}'

Request examples

{
  "tenantId": "string",
  "name": "string",
  "description": "string"
}

Response examples (201)

{
  "tenantId": "string",
  "id": "string",
  "name": "string",
  "description": "string"
}