RoleView
A role — built in or defined by the organization — with its display name and the built-in rank it counts as.
Shape
- 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.
Example
Synthesized example{
"name": "payments-api",
"rank": "guest",
"builtin": "guest",
"custom": "4c7534a7-270b-4a36-bd53-dce110c00d41"
}
Graph
Used inside
Contains
No named schema inside.
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 0 operations
No operation returns it directly.