Ctrl+K

Get policy evaluation

get/api/policy/v1/admin/evaluations/{evaluationId}

Returns a policy evaluation by its ID.

Path Parameters

  • evaluationIdstringRequired
    The ID of the policy evaluation.

Query Parameters

  • includeClausesboolean
    If true, the response includes the clauses of the evaluated policy rule. If absent, defaults to false.

200 Response

id string <UUID>required
Id of the Evaluation. A UUID.
Example: 306258df-dcab-489e-a9fe-ff28ce9fa312
idempotencyKey string required
The idempotency key of the policy evaluation. This is sent upon evaluation by the client. BitGo uses it to ensure idempotency.
Example: 63cf101298470200073bbae71add80d5
scope string required
The scope of the policy evaluation.
Example: wallet.segregated
touchpoint string required
The touchpoint describing what the client request is about. - When the touchpoint has self_controlled=true, evaluation uses rules from that touchpoint instead of Policy Management - For organization-scoped policy changes, this will be "policies.management.edit" while evaluatedTouchpoint will be "organization.role.management"
Example: wallet.segregated.transfer
evaluatedTouchpoint string required
The touchpoint whose policy rules were used to evaluate the request. - Normally this is the same as touchpoint - For self-controlled touchpoints (e.g., organization.role.management), this will be different from touchpoint
Example: wallet.segregated.transfer
clientRequest object required
The client request sent for policy evaluation.
status string required
The status of the policy evaluation.`PENDING` if pending resolution. `ALLOWED` if the touchpoint for this policy evaluation is allowed. `DENIED` if the touchpoint for this policy evaluation is denied.
Allowed values: PENDING ALLOWED DENIED
Example: PENDING
evaluatedPolicyRules array[object] required
An Evaluated Policy Rule, which is the result of evaluating a Policy Rule.
id string required
ID of the evaluated policy rule.
Example: 73bb6587-4f4d-44ce-b189-e8f61e96e544
status string required
Indicates the status of the evaluated policy rule. `TRIGGERED` if the rule is triggered. `NOT_TRIGGERED` if the rule isn't triggered.
Allowed values: TRIGGERED NOT_TRIGGERED
Example: TRIGGERED
filteringConditionInputs object required
The inputs for the filtering conditions that must trigger in order to evaluate this policy rule.
policyRuleId string required
The ID of the policy rule that was evaluated.
Example: 8128f2bb-7481-463c-b018-163cd9131876
version integer required
The version of the policy rule that was evaluated.
Example: 1
clauses array[object]
A evaluated policy rule clause, which is a combination of conditions and actions that were evaluated.
actions array[object] required
A policy action that was evaluated and requires resolution.
id string required
Unique identifier for the evaluated policy action.
status string required
Indicates the status of the evaluated policy action. `PENDING` if the action is pending resolution. `NOT_NEEDED` if the action is not needed. `COMPLETE` if the action is complete. `CANCELLED` if the action is canceled.
Allowed values: PENDING NOT_NEEDED COMPLETE CANCELLED
Example: PENDING
actionAny ofrequired
Automatically reject.
resolution object required
The resolution of the action. This is a free form field that you can use to provide additional information about the resolution of the action.
Example: { "reason": "Rejected by user", "pendingApproval": "664ed267aad92c62a183ac5f28883495"}
resolutionOrder array[object] required
The order in which the actions must be resolved.
actions array[string]
The action ID that must be resolved in this order.
Example: aa371c4c-6adc-4039-ba88-5f9a3e807ca3
createdDate string <date-time>required
The date and time when the policy evaluation was created.
Example: 2024-05-23T05:21:41.805829Z