A role set defines a collection of roles that can be assigned to organization members
| Field | Type | Required | Description |
|---|---|---|---|
object |
RoleSetObject | ✔️ | N/A |
id |
String | ✔️ | The unique identifier of the role set |
name |
String | ✔️ | The name of the role set |
key |
String | ✔️ | A unique key for the role set (e.g., "role_set:default") |
description |
Optional<String> | ✔️ | Optional description of the role set |
roles |
List<RoleSetItem> | ✔️ | The list of roles in this role set |
defaultRole |
JsonNullable<DefaultRole> | ➖ | The default role assigned to new organization members |
creatorRole |
JsonNullable<CreatorRole> | ➖ | The role assigned to the creator of an organization |
type |
Type | ✔️ | The type of the role set ("initial" or "custom") |
roleSetMigration |
JsonNullable<RoleSetMigration> | ➖ | Active migration information, only present when status is "enqueued" or "in_progress" |
createdAt |
long | ✔️ | Unix timestamp of role set creation |
updatedAt |
long | ✔️ | Unix timestamp of last role set update |