wihan/dev

docs /clerk / resources

markdown
browse the clerk docs

clerk_instance_organization_settings (Resource)

Organization settings of the instance. This is a singleton: create adopts the instance, and destroy only removes the resource from state.

Example Usage

resource "clerk_instance_organization_settings" "this" {
  enabled                 = true
  max_allowed_memberships = 5
  admin_delete_enabled    = true
}

Schema

Optional

  • admin_delete_enabled (Boolean) Allow organization admins to delete their organization.
  • creator_role_id (String) Role id for the organization creator. Clerk returns the role name, not the id, so this input is write-only; the name surfaces in creator_role.
  • domains_default_role_id (String) Default role id for domain enrollment. Write-only, like creator_role_id; the name surfaces in domains_default_role.
  • domains_enabled (Boolean) Enable verified domains for organizations.
  • domains_enrollment_modes (List of String) Enrollment modes for verified domains: manual_invitation and/or automatic_invitation, automatic_suggestion.
  • enabled (Boolean) Enable the organizations feature.
  • max_allowed_memberships (Number) Maximum members per organization. 0 means unlimited.

Read-Only

  • creator_role (String) Role name (key) of the organization creator role.
  • domains_default_role (String) Role name (key) of the domain enrollment default role.
  • id (String) Instance id.
  • max_allowed_permissions (Number) Maximum custom permissions per instance.
  • max_allowed_roles (Number) Maximum custom roles per instance.

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

# Any id works; the first refresh replaces it with the real instance id.
terraform import clerk_instance_organization_settings.this instance