Skip to content

Get the role and state policy matrix for one verb

GET
/api/v1/projects/{projectIdOrKey}/access/policy-matrix
curl --request GET \
--url 'https://app.avera.io/api/v1/projects/example/access/policy-matrix?verb=item.edit'

The role by state matrix for one lifecycle and verb, with per-cell explanations. Permission cells are ALLOW rows and anything no cell allows is denied. Passing asUserId collapses the matrix to that user’s evaluated row (view-as), which is audited on the target. Project-admin gated.

projectIdOrKey
required
string
lifecycleId
string
verb
string
default: item.edit
asUserId
string format: uuid

OK

Media type*/*
object
lifecycles
required
Array<object>
object
id
required
string
name
required
string
lifecycleId
required
string
verb
required
string
stateSensitive
required
boolean
states
required
Array<object>
object
id
required
string
name
required
string
directPrincipals
required
Array<string>
rows
required
Array<object>
object
subject
required
object
kind
required
string
Allowed values: ROLE USER
id
required
string
name
required
string
cells
required
Array<object>
object
stateId
required
string
allowed
required
boolean
sources
required
Array<object>
object
kind
required
string
Allowed values: RULE NO_RULE PRINCIPAL_DIRECT NO_PROJECT_ROLES DECISION
detail
required
string
roleId
string | null
stateId
string | null