Skip to content
GitmoapAPIBeta
Organizeaccess
GET/access/permissions

Every permission a role can hold, and the five built-in roles made of them.

list_access_permissions
  • Public
    This operation declares no security requirement: it takes no token.
  • Single-resource

    x-gitmoap-isolation: {"kind":"single_or_self_scoped"}

The same for every caller, and readable without signing in.

Responses

200The permission catalogue and the built-in rolesapplication/json
  • permissionsarray of PermissionInfo
    • The PermissionInfo schema
    • applies_atPermissionAppliesAtscopegrouprepositoryrootWhere a grant carrying a permission has any effect.
    • keystringThe permission's key, {area}.{verb} — for example code.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
200 exampleSynthesized example
{
"permissions": [
{
"applies_at": "scope",
"key": "key-efab",
"lowest_builtin_role": "guest",
"public_readable": false,
"requires": [],
"tier": "standard"
}
],
"roles": [
{
"name": "payments-api",
"permissions": [],
"role": "guest"
}
]
}

CLI

gitmoap access list-access-permissions

Used in these guides