Ctrl+K

List organization policy rules

get/api/policy/v1/organizations/{organizationId}/rules

Lists all policy rules for an organization.

Authorization: Organization admins can access their organization's rules. BitGo admins have access to all organizations.

Path Parameters

  • organizationIdstringRequired
    The organization ID
    Pattern: ^[0-9a-f]{32}$

Query Parameters

  • touchpointsstring
    The Touchpoints of the returned policy rules. One or more may be provided. For example, the Transfer from a Wallet Touchpoint. See also the List scope Touchpoints API.
  • statusstring
    Statuses of the returned policy rules, one or more may be provided.
    Enum: ACTIVE INACTIVE DENIED PENDING_APPROVAL
  • pageintegerDefault: 1
    Page number (1-based)
    Minimum: >= 1
  • pageSizeintegerDefault: 20
    Number of results per page
    Minimum: >= 1
    Maximum: <= 500

200 Response

nextBatchPrevId string required
The value to pass as the prevId to the API for getting the next page.
rules array[object]
A Policy Rule, the combination of a Scope, a Touchpoint, Conditions, and Actions. It allows you to define what needs to happen (Actions) before a user can execute a sensitive operation (Touchpoint) on a Scope (e.g. a Wallet) depending on the specific details of the operation (Conditions). See Concepts.
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.
Example: 306258df-dcab-489e-a9fe-ff28ce9fa312
uniqueId string required
The uniqueId of the Policy Rule version. A UUID.
Example: cb4e0a0a-2768-4024-904a-178ca6d2cd54
name string required
Human readable name of the rule.
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. * `UNLOCK_PENDING` - This version of the policy rule is created when a request to unlock a policy is initiated.
Allowed values: ACTIVE INACTIVE DENIED PENDING_APPROVAL UNLOCK_PENDING
Example: ACTIVE
version integer
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
touchpointId string required
The id of the Touchpoint associated with the Policy Rule. A UUID.
Example: 0a244ae3-26cf-48ed-9854-edd5b9751f3e
touchpointLabel string required
Label of the Touchpoint associated with the Policy Rule. For example the Transfer from a Wallet Touchpoint.
Example: Transfer from a Wallet
scopeId string required
The id of the Scope associated with the Policy Rule. A UUID.
Example: 08a3f714-c330-41e6-bd83-bad3a8d37188
scopeLabel string required
Label of the Scope associated with the Policy Rule. For example the All Wallets Scope.
Example: All Wallets
clauses array[object] required
A combination of Conditions and Actions.
filteringConditionsrequired
Filter by wallet type.
locked boolean required
true, if the Policy Rule is locked, false otherwise.
Example: false
lockType string 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.
Allowed values: LOCK_AFTER_DATE PERMANENT
Example: PERMANENT
lockDate string <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: 2023-11-13T14:49:48.830522Z
enterpriseId string
The id of the Enterprise this Policy Rule belongs to.
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
organizationId string
The id of the Organization this Policy Rule belongs to.
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
lastTriggeredDate string <date-time>
The date when the Policy Rule was last triggered. Only applicable if the Policy Rule is locked with `LOCK_AFTER_DATE`.
Example: 2023-11-13T14:49:48.830522Z
lastTriggeredEvaluationId string
The id of the Evaluation that last triggered the Policy Rule. A UUID.
Example: 306258df-dcab-489e-a9fe-ff28ce9fa312
createdBy string required
The id of the user who created the Policy Rule or the string \"BitGo\".
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
modifiedBy string required
The id of the user who last modified the Policy Rule or the string \"BitGo\".
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
createdDate string <date-time>required
The date when the Policy Rule was created. A timestamp.
Example: 2023-11-13T14:49:48.830522Z
modifiedDate string <date-time>required
The date when the Policy Rule was last modified. A timestamp.
Example: 2023-11-13T14:49:48.830522Z
lockModifiedBy string
The id of the user who last modified the lock of the Policy Rule.
Example: 5d1a5f2c8f0a9c001a5f2c8f0ad00000
evaluationId string
The id of the Evaluation that was done when this Policy Rule version was requested to be created, modified or deleted. A UUID.
Example: 306258df-dcab-489e-a9fe-ff28ce9fa312

401 Response

code string
message string
status integer

404 Response

code string
message string
status integer

500 Response

code string
message string
status integer