Update organization scope

PATCH /api/organization-scopes/{id}

OAuth2

Update organization scope details by ID with the given data.

Path parameters

id string Required

The unique identifier of the organization scope.

application/json

Body Required

tenantId string

Maximum length is 21.
id string

Minimum length is 1, maximum length is 21.
name string

The updated 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 updated description of the organization scope.

Maximum length is 256.

Responses

200 application/json

The organization scope was updated 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
404

Not Found
422

The organization scope name is already in use.

PATCH /api/organization-scopes/{id}

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

Request examples

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

Response examples (200)

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