AccessInheritanceChange
The switch flipped — or, with dry_run, what flipping it would do.
Shape
- dry_runboolean
scopeAccessPageScope
- The AccessPageScope schema
- full_pathstring
- idstring
- inherits_accessbooleanWhether access granted on the groups above reaches it. When it is
false, only access granted here — and the organization's owners — reach it. - typeScopeTypegrouprepository
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
- The AccessScope schema
- full_pathstring
- idstring
- typeScopeTypegrouprepository
- 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
changesstops short of everyone affected. The summary still counts them all.
Example
Synthesized example{
"dry_run": false,
"scope": {
"full_path": "acme/payments-api",
"id": "id-a764",
"inherits_access": false,
"type": "group"
},
"preview": {
"changes": [
{
"gains": [],
"losses": [],
"principal": {
"id": "2d7fd81a-179f-4085-afce-2a0b90b7e24f",
"kind": "user",
"username": "tomas"
},
"scope": {
"full_path": "acme/payments-api",
"id": "id-aba5",
"type": "group"
}
}
],
"summary": {
"people_gaining": 37,
"people_losing": 50,
"scopes_affected": 27
},
"truncated": false
}
}
Graph
Used inside
No schema contains this one.
Contains
Used by
Sent by 0 operations
No operation takes it as a request body.