Skip to content
GitmoapAPIBeta
Schema

RoleChange

A role changed — or, with dry_run, what changing it would do: the permissions everyone holding it gains and loses, and how many grants and limits name it.

Shape

  • dry_runboolean
  • grants_affectedinteger · int64Grants of this role, each of which changes with it — on every group and repository they reach.
  • limits_affectedinteger · int64Limits capping someone at this role.
  • permissions_addedarray of stringPermission keys the role holds after the change and did not before.
  • permissions_removedarray of stringPermission keys the role held before the change and does not after.
  • roleCustomRole
    • 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

Example

Synthesized example
{
"dry_run": false,
"grants_affected": 89,
"limits_affected": 33,
"permissions_added": [
"permissions-added-9a14"
],
"permissions_removed": [
"permissions-removed-50e5",
"permissions-removed-eba6"
],
"role": {
"added": [
"added-63aa",
"added-3287"
],
"base_role": "guest",
"created_at": "2026-10-13T15:04:34Z",
"description": "Renders each region as density contours of its operations.",
"name": "payments-api",
"organization_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"permissions": [
"permissions-c67a"
],
"removed": [
"removed-7663"
],
"role_id": "5231abd1-e18f-40aa-9c89-dac55cc9fe5d",
"slug": "slug-3577",
"updated_at": "2026-10-15T18:47:10Z",
"created_by": {
"email": "mara@acme.example",
"id": "id-50ee",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/94b3f915"
}
}
}

Graph

Used inside

No schema contains this one.

Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 1 operation