Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Policy Builder

Update policy rule

Updates a policy rule, resulting in a new version number that's equal to the highest existing version plus 1. The ID of the policy rule remains the unchanged.

put/api/policy/v1/enterprises/{enterpriseId}/touchpoints/{touchpointName}/rules/{id}

Path parameters

enterpriseIdstring required

Your Enterprise Id.

touchpointNamestring required

The name of the Touchpoint.

idstring required

Id of the policy rule.

Request body

namestring required

Human readable name of the rule.

adminOnlyboolean

true, if the policy rule is a BitGo internal rule, false otherwise.

lockType'LOCK_AFTER_DATE' | 'PERMANENT' | 'NEVER'

Indicates how the policy rule is locked.

  • LOCK_AFTER_DATE - Will lock after the lockDate set on the policy rule.
  • PERMANENT - Is permanently locked.
  • NEVER - Is never locked.
lockDatestring date-time

The date after which the policy rule will be locked. Only applicable if the policy rule is locked with LOCK_AFTER_DATE.

Example request

{
  "name": "Get approval if transferring more than 2 BTC in a minute",
  "clauses": [
    {
      "conditions": [
        {
          "name": "transfer.amount",
          "parameters": {
            "operator": ">",
            "amount": "100000000",
            "coin": "btc"
          },
          "operator": "AND"
        }
      ],
      "actions": [
        {
          "name": "approvals.always.deny"
        }
      ]
    }
  ],
  "filteringConditions": [
    {
      "name": "wallet.ids"
    }
  ],
  "lockType": "PERMANENT",
  "lockDate": "2023-11-13T14:49:48.830522Z"
}

Response

The updated policy rule

idstring 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.

uniqueIdstring required

The uniqueId of the Policy Rule version. A UUID.

namestring required

Human readable name of the rule.

status'ACTIVE' | 'INACTIVE' | 'DENIED' | 'PENDING_APPROVAL' | 'UNLOCK_PENDING' 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.
  • UNLOCK_PENDING - This version of the policy rule is created when a request to unlock a policy is initiated.
versioninteger

The Policy Rule Version, an integer that is incremented each time the Policy Rule changes.

adminOnlyboolean required

true, if the Policy Rule is a BitGo internal rule. Typically, this allows setting Global Policy Rules across enterprises.

touchpointIdstring required

The id of the Touchpoint associated with the Policy Rule. A UUID.

touchpointLabelstring required

Label of the Touchpoint associated with the Policy Rule. For example the Transfer from a Wallet Touchpoint.

scopeIdstring required

The id of the Scope associated with the Policy Rule. A UUID.

scopeLabelstring required

Label of the Scope associated with the Policy Rule. For example the All Wallets Scope.

lockedboolean required

true, if the Policy Rule is locked, false otherwise.

lockType'LOCK_AFTER_DATE' | 'PERMANENT' required

Indicates how the Policy Rule is locked.

  • LOCK_AFTER_DATE - Will lock after the lockDate set on the Policy Rule.
  • PERMANENT - Is permanently locked.
lockDatestring date-time

The date after which the Policy Rule will be locked. Only applicable if the Policy Rule is locked with LOCK_AFTER_DATE.

enterpriseIdstring

The id of the Enterprise this Policy Rule belongs to.

organizationIdstring

The id of the Organization this Policy Rule belongs to.

lastTriggeredDatestring date-time

The date when the Policy Rule was last triggered. Only applicable if the Policy Rule is locked with LOCK_AFTER_DATE.

lastTriggeredEvaluationIdstring

The id of the Evaluation that last triggered the Policy Rule. A UUID.

createdBystring required

The id of the user who created the Policy Rule or the string "BitGo".

modifiedBystring required

The id of the user who last modified the Policy Rule or the string "BitGo".

createdDatestring date-time required

The date when the Policy Rule was created. A timestamp.

modifiedDatestring date-time required

The date when the Policy Rule was last modified. A timestamp.

lockModifiedBystring

The id of the user who last modified the lock of the Policy Rule.

evaluationIdstring

The id of the Evaluation that was done when this Policy Rule version was requested to be created, modified or deleted. A UUID.

Example response

{
  "id": "306258df-dcab-489e-a9fe-ff28ce9fa312",
  "uniqueId": "cb4e0a0a-2768-4024-904a-178ca6d2cd54",
  "name": "My first policy rule",
  "status": "ACTIVE",
  "version": 1,
  "touchpointId": "0a244ae3-26cf-48ed-9854-edd5b9751f3e",
  "touchpointLabel": "Transfer from a Wallet",
  "scopeId": "08a3f714-c330-41e6-bd83-bad3a8d37188",
  "scopeLabel": "All Wallets",
  "clauses": [
    {
      "actions": [
        {
          "name": "approvals.always.deny"
        }
      ],
      "conditions": [
        {
          "name": "transfer.amount",
          "parameters": {
            "operator": ">",
            "amount": "100000000",
            "coin": "btc"
          },
          "operator": "AND"
        }
      ]
    }
  ],
  "filteringConditions": [
    {
      "name": "wallet.type"
    }
  ],
  "lockType": "PERMANENT",
  "lockDate": "2023-11-13T14:49:48.830522Z",
  "enterpriseId": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
  "organizationId": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
  "lastTriggeredDate": "2023-11-13T14:49:48.830522Z",
  "lastTriggeredEvaluationId": "306258df-dcab-489e-a9fe-ff28ce9fa312",
  "createdBy": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
  "modifiedBy": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
  "createdDate": "2023-11-13T14:49:48.830522Z",
  "modifiedDate": "2023-11-13T14:49:48.830522Z",
  "lockModifiedBy": "5d1a5f2c8f0a9c001a5f2c8f0ad00000",
  "evaluationId": "306258df-dcab-489e-a9fe-ff28ce9fa312"
}