Skip to main content

Get an access policy by id

GET 

/api/v1/AccessControlPolicy/:accessControlPolicyId

Returns one access policy with its settings and the ids of the resources, resource groups, credentials and activities it contains. The managedAccountIds and managedAccountGroupIds lists in the response are always empty; list the policy's accounts and account groups with their own list routes. The policy is returned whether or not it is deleted or disabled.

Permission required: Administrator, application, or a custom role with the Access Policies permission on this policy. Multi-factor sign-in is required.

Values for policyType: 0 = Resource, 1 = Credential.

Values for approvalTypeRequired: 0 = Deny, 1 = Allow, 2 = Workflow, 3 = External.

Caution: In the response, approvalTypeRequired is always 0, notesRequired and ticketRequired are always false, and activityConfiguration and activityConfigurationMaxSessionLength are null, whatever the policy's connection profile. Read the connection profile with its own route.

Request​

Responses​

The access policy.