Skip to main content

updateOrganizationSettings()

Updates the Organization-related settings for the current instance.

Returns the updated OrganizationSettings object.

function updateOrganizationSettings(params: UpdateOrganizationSettingsParams): Promise<OrganizationSettings>

UpdateOrganizationSettingsParams

  • Name
    adminDeleteEnabled?
    Type
    boolean | null
    Description

    Whether Organization admins are allowed to delete Organizations.

  • Name
    creatorRoleId?
    Type
    string | null
    Description

    Specifies what the default Organization Role is for an Organization creator.

  • Name
    domainsDefaultRoleId?
    Type
    string | null
    Description

    Specifies what the default Organization Role is for the Organization's Verified Domains.

  • Name
    domainsEnabled?
    Type
    boolean | null
    Description

    Whether Verified Domains are enabled for Organizations.

  • Name
    domainsEnrollmentModes?
    Type
    string[]
    Description

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

  • Name
    enabled?
    Type
    boolean | null
    Description

    Whether the instance should enable Organizations.

  • Name
    maxAllowedMemberships?
    Type
    number | null
    Description

    The maximum number of memberships allowed per Organization.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const response = await clerkClient.instances.updateOrganizationSettings({
  enabled: true,
  maxAllowedMemberships: 10,
  adminDeleteEnabled: true,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint PATCH/instance/organization_settings. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub