SCscalekit
Organizations

Toggle organization settings

Changed on

Updates configuration settings for an organization. Supports modifying SSO configuration, directory synchronization settings, and session parameters. Requires organization ID and the specific settings to update.

patch/api/v1/organizations/{id}/settings

Request

Path parameters

idstring required

Unique identifier of the organization to update settings. Must begin with 'org_' prefix

Request body

Example request

{
  "features": [
    {
      "enabled": true,
      "name": "sso"
    },
    {
      "enabled": false,
      "name": "dir_sync"
    }
  ]
}

Response

Returns the complete organization object with updated settings applied. Contains all organization details including ID, display name, and the modified settings.

Example response

{
  "organization": {
    "create_time": "2025-02-15T06:23:44.560000Z",
    "display_name": "Megasoft",
    "external_id": "my_unique_id",
    "id": "org_59615193906282635",
    "logo_url": "https://cdn.example.com/acme-logo.png",
    "settings": {
      "features": [
        {
          "enabled": true,
          "name": "sso"
        },
        {
          "enabled": false,
          "name": "dir_sync"
        }
      ]
    },
    "slug": "acme",
    "update_time": "2025-02-15T06:23:44.560000Z"
  }
}

Changes

  • 371b89eb40a0Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status