Ctrl+K

Admin Get Policy Evaluation

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

Returns a policy evaluation by its ID.

Path Parameters

  • evaluationIdstringRequired

Query Parameters

  • includeClausesboolean

200 Response

id string required
Min length: >= 1 characters
scopeOne ofrequired
Min length: >= 1 characters
touchpointOne ofrequired
Min length: >= 1 characters
clientRequestOne ofrequired
previousRule
object or null
The previous version of the Policy Rule.
userAction string
Allowed values: OPT_IN OPT_OUT CREATE UPDATE DELETE UNLOCK BULK_UNLOCK BULK_ARCHIVE
id string required
Id of the Policy Rule. This identifier is not unique in isolation, it must be paired with an specific Policy Rule Version number to uniquely identified a particular version of a Policy Rule. A UUID.
Min length: >= 1 characters
Example: 306258df-dcab-489e-a9fe-ff28ce9fa312
uniqueId string required
The uniqueId of the Policy Rule version. A UUID.
Min length: >= 1 characters
Example: cb4e0a0a-2768-4024-904a-178ca6d2cd54
enterpriseId string required
The id of the Enterprise this Policy Rule belongs to.
Min length: >= 1 characters
Example: 59cd72485007a239fb00282ed480da1f
name string required
Human readable name of the rule
Min length: >= 1 characters
Example: My first policy rule
status string required
Indicates if the Policy Rule is considered in Evaluations. * "ACTIVE" - Will be Evaluated. * "INACTIVE" - Will NOT be Evaluated. * "DENIED" - The requested policy rule change was Denied. * "PENDING_APPROVAL" - This version of the policy rule is Pending Approval before it can be activated.
Allowed values: ACTIVE INACTIVE PENDING PENDING_APPROVAL DENIED UNLOCK_PENDING
Example: ACTIVE
version number required
The Policy Rule Version, an integer that is incremented each time the Policy Rule changes.
Default: 1
Example: 1
adminOnly boolean required
true, if the Policy Rule is a BitGo internal rule. Typically, this allows setting Global Policy Rules across enterprises.
Example: false
filteringConditions array[object] required
Filter by wallet type.
createdBy string required
The id of the user who created the Policy Rule or the string 'BitGo'.
Min length: >= 1 characters
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
modifiedBy string required
The id of the user requesting to modify the Policy Rule or the string 'BitGo'.
Min length: >= 1 characters
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
ip string
Min length: >= 1 characters
requestId string
Min length: >= 1 characters
previousUniqueId string
Min length: >= 1 characters
clauses array[object]
List of Policy Rule Clauses: a combination of Conditions and Actions.
lockModifiedBy string
The id of the user requesting to unlock the Policy Rule.
Min length: >= 1 characters
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
lockDate string
The timestamp until which the Policy Rule is unlocked. This is a string representing a date in ISO 8601 format.
Min length: >= 1 characters
status string required
Allowed values: PENDING ALLOWED DENIED
actions array[object] required
id string required
Min length: >= 1 characters
status string required
Allowed values: SKIPPED PENDING NOT_NEEDED COMPLETE CANCELLED FAILED AUTO_CANCELLED
action object required
policyRuleId string
Min length: >= 1 characters
resolution object
resolutionOrder array[object] required
actions array[string] required
idempotencyKey string required
Min length: >= 1 characters
evaluatedPolicyRules array[object] required
id string required
Min length: >= 1 characters
status string required
Allowed values: TRIGGERED NOT_TRIGGERED
policyRuleName string required
Min length: >= 1 characters
isBitGoManagedRule boolean required
filteringConditionInputs dictionary<string, any> required
policyRuleId string required
Min length: >= 1 characters
version number required
isAdminOnlyRule boolean
clauses array[object]
createdDate string <date-time>required

404 Response

One of
error string required
code string required

500 Response

One of
error string required
code string required