OPopal
resources

PATCH /resources/{resource_id}/custom-access-levels/{access_level_remote_id}

Changed on

Updates a custom access level identified by its remote ID. If the resource is a parent type, the update fans out to all child resources.

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

resource_idstring uuid required

The ID of the resource.

access_level_remote_idstring required

The remote ID of the access level.

Request body

access_level_namestring

The new human-readable name.

policystring nullable

The new policy document.

requestable_by_defaultboolean

Whether the role is requestable.

stackable_sensitivity_indexinteger nullable

The new sensitivity index.

clear_stackable_sensitivity_indexboolean

Set to true to remove from the hierarchy.

Response

The updated custom access level.

resource_custom_access_level_idstring uuid required

The unique ID of the custom access level.

resource_idstring uuid required

The resource this access level belongs to.

policystring nullable

The policy document for this access level.

requestable_by_defaultboolean required

Whether this role is requestable.

stackable_sensitivity_indexinteger nullable

The sensitivity index in the access hierarchy. Null if unranked.

member_resource_idsstring[] nullable

When addressed via a parent resource, lists the child resource IDs that back this aggregated entry.

created_atstring date-time
updated_atstring date-time

Example response

{
  "access_level": {
    "access_level_name": "AdminRole",
    "access_level_remote_id": "arn:aws:iam::590304332660:role/AdministratorAccess"
  }
}

Changes