Skip to content
GitmoapAPIBeta
Schema

AccessLimitChange

A limit set — or, with dry_run, what setting it would do.

Shape

  • limitAccessLimit
    • The AccessLimit schema
    • atAccessScopeWhere the limit is set. It caps its subject there and everywhere beneath, including beneath a group or repository that does not inherit access.
    • created_atstring · date-time
    • limit_idLimitId (string · uuid)
    • ceilingRoleView or nulloptionalThe most the subject may hold. Absent when the limit allows nothing at all.
      • 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.
    • created_byActorSummary or nulloptional
    • reasonstring or nulloptional
  • previewAccessPreview or nulloptional
    • The AccessPreview schema
    • changesarray of AccessDeltaEach person whose access would change at the group or repository the change is made on.
      • The AccessDelta schema
      • gainsarray of stringPermissions they would hold that they do not hold now, by key.
      • lossesarray of stringPermissions they hold now that they would no longer hold, by key.
      • principalPrincipalSummary
        • The PrincipalSummary schema
        • idPrincipalId (string · uuid)
        • kindPrincipalKinduserservice_accountagentA person, a service account or an AI organization's agent.
        • usernamestring
        • avatar_urlstring or nulloptional
      • scopeAccessScope
      • rank_afterAccessLevelguestreporterdevelopermaintainerowneror nulloptional
      • rank_beforeAccessLevelguestreporterdevelopermaintainerowneror nulloptional
    • summaryAccessPreviewSummary
      • The AccessPreviewSummary schema
      • people_gaininginteger · int320–∞
      • people_losinginteger · int320–∞
      • scopes_affectedinteger · int64The group or repository the change is made on, plus every one beneath it that inherits access and so changes with it.
    • truncatedbooleanWhether changes stops short of everyone affected. The summary still counts them all.
  • warningsarray of LimitWarning: one of limit_cannot_hide_publicoptional

Example

Synthesized example
{
"limit": {
"at": {
"full_path": "acme/payments-api",
"id": "id-c01c",
"type": "group"
},
"created_at": "2026-10-11T03:24:50Z",
"limit_id": "723e3b92-ae97-43cc-9bd1-4bd90a60e88e",
"subject": {
"principal": {
"id": "0ef5c7f2-c253-434a-8b0a-48d86a73378e",
"kind": "user",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/1b4642e0"
}
},
"ceiling": {
"name": "payments-api",
"rank": "guest",
"builtin": "guest",
"custom": "3a8dee52-545c-4210-9750-1f1f22ac772a"
},
"created_by": {
"email": "tomas@acme.example",
"id": "id-0ea9",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/6b315744"
},
"reason": "reason-c70f"
},
"preview": {
"changes": [
{
"gains": [],
"losses": [],
"principal": {
"id": "476ac09e-df9f-4997-8dab-6b475cd00b76",
"kind": "user",
"username": "mara"
},
"scope": {
"full_path": "acme/payments-api",
"id": "id-78cc",
"type": "group"
}
},
{
"gains": [],
"losses": [],
"principal": {
"id": "34a56199-0be1-461b-9c09-b59e5eb8656c",
"kind": "user",
"username": "mara"
},
"scope": {
"full_path": "acme/payments-api",
"id": "id-ac6e",
"type": "group"
}
}
],
"summary": {
"people_gaining": 26,
"people_losing": 89,
"scopes_affected": 73
},
"truncated": false
},
"warnings": [
"limit_cannot_hide_public"
]
}

Graph

Used inside

No schema contains this one.

Used by