AccessCatalogue
The permission catalogue and the built-in roles made of it.
Shape
permissionsarray of PermissionInfo
- The PermissionInfo schema
- applies_atPermissionAppliesAtscopegrouprepositoryrootWhere a grant carrying a permission has any effect.
- keystringThe permission's key,
{area}.{verb}— for examplecode.push. - lowest_builtin_roleAccessLevelguestreporterdevelopermaintainerownerThe lowest built-in role that holds this permission. Every higher built-in role holds it as well.
- public_readablebooleanWhether a Public or Internal group or repository lets people read this without being given access.
- requiresarray of stringThe permissions this one is meaningless without. A role that holds it holds these too.
- tierPermissionTierstandardsensitivereservedHow dangerous granting a permission is, which decides whether a custom role may carry it.
rolesarray of BuiltinRoleInfoThe five built-in roles, lowest first.
- The BuiltinRoleInfo schema
- namestringThe role's display name, such as
Developer. - permissionsarray of stringEvery permission the role holds, by key.
- roleAccessLevelguestreporterdevelopermaintainerowner
Example
Synthesized example{
"permissions": [
{
"applies_at": "scope",
"key": "key-9926",
"lowest_builtin_role": "guest",
"public_readable": false,
"requires": [],
"tier": "standard"
},
{
"applies_at": "scope",
"key": "key-fbd1",
"lowest_builtin_role": "guest",
"public_readable": false,
"requires": [],
"tier": "standard"
}
],
"roles": [
{
"name": "payments-api",
"permissions": [],
"role": "guest"
},
{
"name": "payments-api",
"permissions": [],
"role": "guest"
}
]
}
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