Skip to content
GitmoapAPIBeta
Schema

ExplainedGrant

One grant an explanation considered.

Shape

  • atAccessScope
  • outcomeGrantOutcomeViewreachesstopped_by_boundaryexpiredWhat became of one grant in an explanation.
  • roleRoleView
    • The RoleView schema
    • namestringThe role's display name: a built-in name such as Developer, or the custom role's name.
    • rankAccessLevelguestreporterdevelopermaintainerownerThe built-in rank the role counts as wherever a rank is compared, such as a protected branch's minimum.
    • builtinAccessLevelguestreporterdevelopermaintainerowneror nulloptionalSet when the role is built in.
    • customRoleId (string · uuid) or nulloptionalSet when the role is one the organization defined.
  • expires_atstring · date-time or nulloptional

Example

Synthesized example
{
"at": {
"full_path": "acme/payments-api",
"id": "id-3d18",
"type": "group"
},
"outcome": "reaches",
"role": {
"name": "payments-api",
"rank": "guest",
"builtin": "guest",
"custom": "1de6d3ba-c378-4f2a-b4a7-199013c74f2b"
},
"via": "direct",
"expires_at": "2026-10-10T21:14:34Z"
}

Graph

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.