GET/roles/{name}/storage-compliance

Get the storage compliance report of a role

Returns the stored configurations of the role that its storage allowlist rejects: the entity, the field the value was read from and the rule that rejected it. The report is computed on demand. Enabling resource_isolation validates the role alone and leaves the stored configurations untouched, so call this endpoint before enabling it to see what the allowlist would reject: narrowing an allowlist applies to the next save of each resource. The report also carries the posture findings, which describe how wide the isolation is rather than what is wrong with it, and are computed while the role isolates. The report requires the "*" permission: its findings name administrators and resources of every role.

2 parameters
namestringrequired
role name
csv_exportbooleanoptional
Export the findings as a CSV file. The export streams every finding, the JSON answer is capped

7 status codes
200successful operation
findingsarray<object>optional
resource_isolationintegeroptional
rolestringoptional
truncatedbooleanoptional
The findings reached the cap of the JSON answer. Use the CSV export, which streams every finding
400Bad Request
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Not Found
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty

Error handling

A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 404 is returned: Not Found. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.