A Team Role defines a set of system permissions granted to members of a team. Teams can utilize built-in managed roles or create custom roles with tailored permission subsets.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier for the team role. |
created_date | Date | Date when the role was created. |
updated_date | Date | Last modification timestamp. |
name | String | Name of the role (e.g. "Integration Manager"). |
description | String | Optional description of the role responsibilities. |
permissions | Array | Array of system permission slugs. |
managed | Boolean | True for default platform roles that cannot be altered. |
team_id | UUID | Associated team identifier. |
JSON Example
{
"id": "3b7d4bad-9bdd-2b0d-7b3d-cb6d9b1deb4d",
"name": "Integration Manager",
"description": "Full access to configure and monitor school integrations",
"permissions": [
"integrations.read",
"integrations.create",
"integrations.update",
"sources.read",
"rules.read"
],
"managed": false,
"team_id": "6a9e99a8-e165-4d0d-9b7d-6062a4be682d"
}