clerk_organization_role (Resource)

A custom organization role with its permission set.

Example Usage

resource "clerk_organization_role" "billing_admin" {
  name        = "Billing admin"
  key         = "org:billing_admin"
  description = "Full access to billing."

  permissions = [
    clerk_organization_permission.invoices_read.id,
  ]
}

Schema

Required

• key (String) Role key, for example org:billing_admin. Membership resources reference this key.
• name (String) Display name.

Optional

• description (String) Free-form description.
• permissions (Set of String) Ids of the permissions of this role (perm_...). The whole set updates in place.

Read-Only

• id (String) Role id (role_...).
• is_creator_eligible (Boolean) true when the role can be the organization creator role.

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

terraform import clerk_organization_role.billing_admin role_2abcDEFghiJKLmnoPQRstuVWXyz