Rule Instance - List | Flagright

1 curl https://sandbox.api.flagright.com/management/rule-instances \ 2 -H "x-api-key: <x-api-key>"

1 [ 2 { 3 "id": "foo", 4 "type": "TRANSACTION", 5 "ruleId": "foo", 6 "checksFor": [ 7 "foo" 8 ], 9 "runCount": 42, 10 "hitCount": 42, 11 "createdAt": 42, 12 "updatedAt": 42, 13 "alertCreationOnHit": true, 14 "filters": {}, 15 "parameters": {}, 16 "ruleNameAlias": "foo", 17 "riskLevelParameters": { 18 "VERY_HIGH": {}, 19 "HIGH": {}, 20 "MEDIUM": {}, 21 "LOW": {}, 22 "VERY_LOW": {} 23 }, 24 "action": "ALLOW", 25 "riskLevelActions": { 26 "VERY_HIGH": "ALLOW", 27 "HIGH": "ALLOW", 28 "MEDIUM": "ALLOW", 29 "LOW": "ALLOW", 30 "VERY_LOW": "ALLOW" 31 }, 32 "triggersOnHit": { 33 "usersToCheck": "ALL", 34 "userStateDetails": { 35 "reason": "foo", 36 "state": "UNACCEPTABLE", 37 "description": "foo" 38 }, 39 "kycStatusDetails": { 40 "reason": "foo", 41 "status": "SUCCESSFUL", 42 "description": "foo" 43 }, 44 "pepStatus": { 45 "isPepHit": true, 46 "pepCountry": "AF", 47 "pepRank": "LEVEL_1" 48 } 49 }, 50 "riskLevelsTriggersOnHit": { 51 "VERY_HIGH": { 52 "usersToCheck": "ALL", 53 "userStateDetails": { 54 "reason": "foo", 55 "state": "UNACCEPTABLE", 56 "description": "foo" 57 }, 58 "kycStatusDetails": { 59 "reason": "foo", 60 "status": "SUCCESSFUL", 61 "description": "foo" 62 }, 63 "pepStatus": { 64 "isPepHit": true, 65 "pepCountry": "AF", 66 "pepRank": "LEVEL_1" 67 } 68 }, 69 "HIGH": { 70 "usersToCheck": "ALL", 71 "userStateDetails": { 72 "reason": "foo", 73 "state": "UNACCEPTABLE", 74 "description": "foo" 75 }, 76 "kycStatusDetails": { 77 "reason": "foo", 78 "status": "SUCCESSFUL", 79 "description": "foo" 80 }, 81 "pepStatus": { 82 "isPepHit": true, 83 "pepCountry": "AF", 84 "pepRank": "LEVEL_1" 85 } 86 }, 87 "MEDIUM": { 88 "usersToCheck": "ALL", 89 "userStateDetails": { 90 "reason": "foo", 91 "state": "UNACCEPTABLE", 92 "description": "foo" 93 }, 94 "kycStatusDetails": { 95 "reason": "foo", 96 "status": "SUCCESSFUL", 97 "description": "foo" 98 }, 99 "pepStatus": { 100 "isPepHit": true, 101 "pepCountry": "AF", 102 "pepRank": "LEVEL_1" 103 } 104 }, 105 "LOW": { 106 "usersToCheck": "ALL", 107 "userStateDetails": { 108 "reason": "foo", 109 "state": "UNACCEPTABLE", 110 "description": "foo" 111 }, 112 "kycStatusDetails": { 113 "reason": "foo", 114 "status": "SUCCESSFUL", 115 "description": "foo" 116 }, 117 "pepStatus": { 118 "isPepHit": true, 119 "pepCountry": "AF", 120 "pepRank": "LEVEL_1" 121 } 122 }, 123 "VERY_LOW": { 124 "usersToCheck": "ALL", 125 "userStateDetails": { 126 "reason": "foo", 127 "state": "UNACCEPTABLE", 128 "description": "foo" 129 }, 130 "kycStatusDetails": { 131 "reason": "foo", 132 "status": "SUCCESSFUL", 133 "description": "foo" 134 }, 135 "pepStatus": { 136 "isPepHit": true, 137 "pepCountry": "AF", 138 "pepRank": "LEVEL_1" 139 } 140 } 141 }, 142 "status": "ACTIVE", 143 "casePriority": "P1" 144 } 145 ]

Retrieve Rule Instances

GET /rule-instances endpoint returns a list of all rule instances created by your account on flagright.

Response

idstring

typeenum

Allowed values:

ruleIdstring

checksForlist of strings

runCountdouble or null

hitCountinteger or null

createdAtdouble or null

updatedAtdouble or null

alertCreationOnHitboolean or null

filtersobject or null

Rule filters. A key-value json object corresponding to the json schema returned by /rule-filters-schema endpoint.

parametersobject or null

ruleNameAliasstring or null

riskLevelParametersobject or null

actionenum or null

Model for rule action if a rule is hit. This is returned in the API response and can be configured on Console by operational accounts like a Compliance Analyst

Allowed values:

riskLevelActionsobject or null

triggersOnHitobject or null

riskLevelsTriggersOnHitobject or null

statusenum or null

Allowed values:

casePriorityenum or null

Allowed values:

Retrieve Rule Instances

Headers

Response