Skip to content
GitmoapAPIBeta
Schema

AccessGrant

One grant.

Shape

  • created_atstring · date-time
  • grant_idGrantId (string · uuid)
  • 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.
  • scopeAccessScopeWhere the grant was made.
  • updated_atstring · date-time
  • expires_atstring · date-time or nulloptional
  • granted_byActorSummary or nulloptionalWho made the grant. Absent for access the platform created — the creator of a group or repository, or a copied membership.
  • last_exercised_atstring · date-time or nulloptionalWhen the grant last let somebody do something, to the day. Absent until it has.
  • reasonstring or nulloptional

Example

Synthesized example
{
"created_at": "2026-10-12T02:34:13Z",
"grant_id": "6d4da50f-384a-48bf-b59d-6d193b8cb328",
"role": {
"name": "payments-api",
"rank": "guest",
"builtin": "guest",
"custom": "58039e01-9320-4efe-8a39-c9c937d017e1"
},
"scope": {
"full_path": "acme/payments-api",
"id": "id-82ad",
"type": "group"
},
"subject": {
"principal": {
"id": "3a56f289-e695-43c6-a361-e86c4e52d12b",
"kind": "user",
"username": "mara",
"avatar_url": "https://gitmoap.example/acme/846bf530"
}
},
"updated_at": "2026-10-15T02:33:07Z",
"expires_at": "2026-10-13T09:44:40Z",
"granted_by": {
"email": "mara@acme.example",
"id": "id-5d26",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/6e538aa7"
},
"last_exercised_at": "2026-10-12T05:23:47Z",
"reason": "reason-10ee"
}

Graph

Used by