Get Policy Rule By ID

GET /policies/policy-rules/{policyRuleId}

Retrieves a PolicyRule by its id.

Required Permissions

NameConditions

PolicyRules:Read

Always Required

Parameters

Path parameters

Path parameterDescription

policyRuleId

Unique identifier of the policy rule like: pr-orange-magnesium-a0606d08b2

Response

Response example

If successful, the response contains, among other things, a status indicating whether the rule has been enabled:

{
   "id": "pr-tennessee-artist-f2078ea085",
   "version": "f1b1me4kd",
   "kind": "TransferAmountLimit",
   "orgId": "cu-purple-pip-1b417b958500",
   "author": "oe-nine-artist-9de60fef6963",
   "description": "Test Rule 1 PaymentAmountLimit",
   "name": "Test Rule 1",
   "configuration": {
       "kind": "TransferAmountLimit",
       "limit": "10",
       "currency": "USD"
   },
   "tags": [],
   "dateCreated": "2022-07-14T21:22:54.829Z",
   "status": "Enabled"
}

Last updated