Instance Settings

Update instance organization settings

Changed on

Updates the organization settings of the instance

patch/instance/organization_settings

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/instance/organization_settings
  • Auth: HTTP bearer

Request body

enabledboolean nullable
max_allowed_membershipsinteger nullable
admin_delete_enabledboolean nullable
domains_enabledboolean nullable
slug_disabledboolean nullable
domains_enrollment_modesstring[]

Specify which enrollment modes to enable for your Organization Domains. Supported modes are 'automatic_invitation' & 'automatic_suggestion'.

creator_role_idstring nullable

Specify what the default organization role is for an organization creator.

domains_default_role_idstring nullable

Specify what the default organization role is for the organization domains.

Response

Success

object'organization_settings' required

String representing the object's type. Objects of the same type share the same value.

enabledboolean required
max_allowed_membershipsinteger required
max_allowed_rolesinteger required
max_role_sets_allowedinteger
max_allowed_domainsinteger required
max_allowed_permissionsinteger

max_allowed_permissions is now a no-op, as permissions are now unlimited

creator_rolestring required

The role key that a user will be assigned after creating an organization.

admin_delete_enabledboolean required

The default for whether an admin can delete an organization with the Frontend API.

domains_enabledboolean required
slug_disabledboolean
domains_enrollment_modesstring[] required
domains_default_rolestring required

The role key that it will be used in order to create an organization invitation or suggestion.

initial_role_set_keystring nullable

The role set key that it will be used to create new organizations.

Changes