Organizations

Update organization

Changed on

Update organization details by ID with the given data.

patch/api/organizations/{id}

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/organizations/{id}
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the organization.

Request body

tenantIdstring
namestring

The updated name of the organization.

descriptionstring nullable

The updated description of the organization.

customDataobject

arbitrary

isMfaRequiredboolean
isTrustedDeviceAllowedboolean
customCssstring nullable
createdAtnumber

Response

The organization was updated successfully.

tenantIdstring required
idstring required
namestring required
descriptionstring nullable required
customDataobject required

arbitrary

isMfaRequiredboolean required
isTrustedDeviceAllowedboolean required
customCssstring nullable required
createdAtnumber required

Changes