Skip to content
GitmoapAPIBeta
Schema

RolePage

A page of an organization's custom roles.

Shape

  • rolesarray of CustomRole
    • The CustomRole schema
    • addedarray of stringPermissions added to the base, by key.
    • base_roleAccessLevelguestreporterdevelopermaintainerownerThe built-in role this one starts from, and whose rank it counts as wherever a rank is compared, such as a protected branch's minimum.
    • created_atstring · date-time
    • descriptionstring
    • namestring
    • organization_idGroupId (string · uuid)The organization's top-level group.
    • permissionsarray of stringEverything the role holds: the base, the additions and what they need, less the removals.
    • removedarray of stringPermissions removed from the base, by key.
    • role_idRoleId (string · uuid)
    • slugEntityName (string)
    • updated_atstring · date-time
    • created_byActorSummary or nulloptional
  • next_tokenstring or nulloptional

Example

Synthesized example
{
"roles": [
{
"added": [],
"base_role": "guest",
"created_at": "2026-10-14T04:30:48Z",
"description": "Renders each region as density contours of its operations.",
"name": "payments-api",
"organization_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"permissions": [],
"removed": [],
"role_id": "a85d001e-6de8-4371-8da8-6ffeb8098d5f",
"slug": "slug-f027",
"updated_at": "2026-10-11T02:11:31Z"
},
{
"added": [],
"base_role": "guest",
"created_at": "2026-10-11T11:52:21Z",
"description": "Renders each region as density contours of its operations.",
"name": "payments-api",
"organization_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"permissions": [],
"removed": [],
"role_id": "f7234003-9a87-4adc-9070-534d1072a2df",
"slug": "slug-c2e5",
"updated_at": "2026-10-15T04:28:07Z"
}
],
"next_token": "next-token-b941"
}

Graph

Used inside

No schema contains this one.

Contains

Used by

Sent by 0 operations

No operation takes it as a request body.