Skip to main content
GET
Resolve applicable policies

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Query Parameters

resourceType
enum<string>
required

Which namespace resourceId belongs to, and which family of policies to return. Which namespace a resource id belongs to, and which family of action types that resource participates in:

  • ACCOUNT — transaction action types (WITHDRAWAL, DEPOSIT) and trusted-destination action types (TRUSTED_DESTINATION_ADD, TRUSTED_DESTINATION_REMOVE). A trusted destination is added to or removed from an account, so such a policy scopes to an account, to any account above it, or to the organization — never to an individual destination.
  • POLICY — policy-governance action types (POLICY_CREATE, POLICY_ARCHIVE).
  • KEY — approval-key-governance action types (KEY_REGISTER, KEY_ARCHIVE).
  • APPROVAL_GROUP — approval-group-governance action types (KEY_GROUP_CREATE, KEY_GROUP_ARCHIVE).

For the creation action types (POLICY_CREATE, KEY_REGISTER, KEY_GROUP_CREATE) there is no resource yet, so a policy's resourceIds are the root account ids it governs even though its resourceType names the family being created.

Available options:
ACCOUNT,
POLICY,
KEY,
APPROVAL_GROUP
resourceId
string<uuid>
required

The resource of resourceType to resolve policies for, in canonical lowercase hyphenated UUID form (any other spelling is rejected with 400). For ACCOUNT, its parent chain is matched as well; for a creation action type's family, the root account id. A UUID in canonical lowercase hyphenated form.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

actionType
enum<string>

Filter to policies governing this action type.

Available options:
WITHDRAWAL,
DEPOSIT,
TRUSTED_DESTINATION_ADD,
TRUSTED_DESTINATION_REMOVE,
POLICY_CREATE,
POLICY_ARCHIVE,
KEY_REGISTER,
KEY_ARCHIVE,
KEY_GROUP_CREATE,
KEY_GROUP_ARCHIVE
status
enum<string>

Filter to policies in this status. Defaults to ACTIVE; pass ARCHIVED to audit retired policies.

Available options:
PENDING_APPROVAL,
ACTIVE,
ARCHIVED
after
string

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

Minimum string length: 1
limit
integer<int64>
default:100

Maximum number of results to return per query

Required range: 1 <= x <= 1000

Response

Success

data
Policy · object[]
required
page
Page · object
required

Pagination info

chain
string<uuid>[]

The resource followed by each of its parent accounts, nearest first. Present only when the query supplied a resourceId, and only for resourceType ACCOUNT — the other resource types have no parent chain. Describes the query rather than the page, so it repeats identically on every page.