-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpingone-risk.yml
2104 lines (2104 loc) · 84.1 KB
/
pingone-risk.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: PingOne Platform API - PingOne Risk
description: The PingOne Platform API covering the PingOne Risk service
version: '2023-06-29'
externalDocs:
url: https://apidocs.pingidentity.com/pingone/platform/v1/api/#pingone-risk
description: PingOne Platform API Reference - PingOne Risk APIs
servers:
- url: '{protocol}://{baseDomain}.{suffix}/v1'
description: PingOne Platform API Endpoint
variables:
suffix:
enum:
- 'asia'
- 'ca'
- 'com'
- 'com.au'
- 'eu'
default: 'com'
baseDomain:
default: 'api.pingone'
protocol:
default: 'https'
- url: '{protocol}://{baseHostname}/v1'
description: PingOne Platform API Endpoint
variables:
baseHostname:
default: 'api.pingone.com'
protocol:
default: 'https'
components:
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: OAuth bearer token (see documentation)
schemas:
LinksHATEOAS:
x-pingidentity-paginatedresponse-links: true
type: object
readOnly: true
additionalProperties:
type: object
properties:
href:
type: string
format: uri
description: The HREF of the link.
required:
- href
EnumCompletionStatus:
type: string
enum: [FAILED, IN_PROGRESS, SUCCESS]
description: A string that specifies the state of the transaction. Options are `FAILED`, `IN_PROGRESS`, and `SUCCESS`. If a value is not provided, the value defaults to `IN_PROGRESS`. The value of this property can be changed only if its current state is `IN_PROGRESS`.
EnumDistanceUnit:
type: string
enum: [kilometers, miles]
description: A string that specifies the unit of distance. Options are `kilometers`, `miles`.
EnumEventSharingType:
type: string
enum: [UNSPECIFIED, SHARED, PRIVATE]
description: A string that specifies the device sharing type. Options are `UNSPECIFIED`, `SHARED`, and `PRIVATE`.
EnumFlowType:
type: string
enum: [AUTHENTICATION, REGISTRATION, ACCESS, AUTHORIZATION, TRANSACTION]
default: AUTHENTICATION
description: |
The type of flow for which the risk evaluation is being carried out. Can take any of the following values:
`REGISTRATION` - initial registration of an account
`AUTHENTICATION` - standard authentication for login or actions such as password change
`ACCESS` - verification of whether user can access the relevant application, using tools such as PingAccess
`AUTHORIZATION` - verification of whether user is authorized to perform a specific action such as a profile change, using tools such as PingOne Authorize
`TRANSACTION` - authentication carried out in the context of a purchase or other monetary transaction
The default value is `AUTHENTICATION`.
EnumRiskPolicyConditionType:
type: string
description: |
Indicates the type of policy you are defining. Can be one of the following values: `AGGREGATED_SCORES`, `AGGREGATED_WEIGHTS`, `VALUE_COMPARISON`, and `IP_RANGE` (for override policies or custom predictors).
enum: [AGGREGATED_WEIGHTS, AGGREGATED_SCORES, VALUE_COMPARISON, IP_RANGE]
EnumRiskPolicyResultLevel:
type: string
enum: [LOW]
description: Contains the default result level returned if none of the conditions in the policy are evaluated to true. At this time, the value must be `LOW`.
EnumRiskPolicySetTriggerType:
type: string
enum: [POLICY_SET_STAGING]
description: A string that specifies the trigger type for the policy set. The only option is `POLICY_SET_STAGING`.
EnumPredictorCompositeConditionType:
type: string
enum: [VALUE_COMPARISON, STRING_LIST, AND, NOT, OR]
EnumPredictorNewDeviceDetectType:
type: string
description: Used only for New Device predictors and Suspicious Device predictors. Both of these predictor types use the value `DEVICE` for `type`. The `detect` field is used to specify the kind of devices you are trying to detect.
enum: [NEW_DEVICE, SUSPICIOUS_DEVICE]
EnumPredictorType:
type: string
enum: [ADVERSARY_IN_THE_MIDDLE, ANONYMOUS_NETWORK, BOT, COMPOSITE, DEVICE, EMAIL_REPUTATION, GEO_VELOCITY, IP_REPUTATION, MAP, TRAFFIC_ANOMALY, USER_LOCATION_ANOMALY, USER_RISK_BEHAVIOR, VELOCITY]
description: An enum type that specifies the type of the predictor. Note that both the New Device and Suspicious Device predictors use the type DEVICE. To differentiate between them, you use the `detect` field.
EnumPredictorUnit:
type: string
enum: [DAY, HOUR]
EnumPredictorVelocityFallbackStrategy:
type: string
enum: [ENVIRONMENT_MAX]
EnumPredictorVelocityMeasure:
type: string
enum: [DISTINCT_COUNT]
EnumPredictorVelocityUseType:
type: string
enum: [POISSON_WITH_MAX]
EnumRiskPredictorTrafficAnomalyRuleIntervalUnit:
type: string
enum: [DAY, HOUR]
description: The time unit for defining the timeframe for tracking number of users on the device - can be `DAY` or `HOUR`
EnumRiskPredictorTrafficAnomalyRuleType:
type: string
enum: [UNIQUE_USERS_PER_DEVICE]
description: The type of rule. Currently the only valid value is `UNIQUE_USERS_PER_DEVICE` - for tracking the number of unique users for a device over a defined timeframe.
EnumResultType:
type: string
enum: [VALUE]
description: A string that specifies the risk evaluation result type. Options are `VALUE`.
EnumRiskLevel:
type: string
enum: [LOW, MEDIUM, HIGH]
description: Enum string that specifies a given risk level. Options are `LOW`, `MEDIUM`, `HIGH`.
EnumUserRiskBehaviorRiskModel:
type: string
enum: [points, login_anomaly_statistic]
description: Enum string that specifies the risk model. Options are `points` (individual user model) and `login_anomaly_statistic` (organization wide model).
EnumThresholdSource:
type: string
enum: [MIN_NOT_REACHED, CALCULATED, ENVIRONMENT_FALLBACK, DEFAULT_FALLBACK]
description: >-
An enum indicating the source used to calculate the threshold. This can be
`MIN_NOT_REACHED`. If the measure is less than `every.minSample`, the threshold isn't calculated. Instead, a value of `LOW` is automatically assigned. If less than five IPs were used by the user during the past hour, `MIN_NOT_REACHED` is set.
`CALCULATED`. Indicates the threshold is guaranteed to be calculated.
`ENVIRONMENT_FALLBACK`. Indicates a global threshold calculated for the entire environment is used. The global threshold is used when the `ipVelocityByUser.threshold` couldn't be calculated, generally due to a lack of past transactions for the risk predictor to use for the threshold calculation.
`DEFAULT_FALLBACK`. Indicates the default threshold defined for the predictor (in `threshold.medium` or `threshold.high`) is used. The default threshold is used when `ENVIRONMENT_FALLBACK` (the global threshold) couldn't be calculated, generally due to a lack of past transactions for the risk predictor to use for the environment threshold calculation.
EnumUserType:
type: string
enum: [EXTERNAL]
description: A string that specifies the type of user associated with the event. Options are `EXTERNAL`.
ObjectEnvironment:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the environment associated with the object.
P1Error:
type: object
properties:
id:
description: A unique identifier that is stored in log files and always included in an error response. This value can be used to track the error received by the client, with server-side activity included for troubleshooting purposes.
type: string
code:
description: A general fault code which the client must handle to provide all exception handling routines and to localize messages for users. This code is common across all PingOne services and is human readable (such as a defined constant rather than a number).
type: string
message:
description: A short description of the error. This message is intended to assist with debugging and is returned in English only.
type: string
details:
description: Additional details about the error. Optional information to help resolve the error and to display to users.
type: array
items:
type: object
properties:
code:
description: A general fault code which the client must handle to provide all exception handling routines and to localize messages for users. This code is common across all PingOne services and is human readable (such as a defined constant rather than a number).
type: string
target:
description: The item that caused the error (such as a form field ID or an attribute inside a JSON object).
type: string
message:
description: A short description of the error. This message is intended to assist with debugging and is returned in English only.
type: string
innerError:
description: Additional details to help the client developer resolve the fault (primarily for UI validation reasons).
type: object
properties:
rangeMinimumValue:
description: Errors that failed due to range violation. This attribute represents the minimum value of the range.
type: integer
rangeMaximumValue:
description: The maximum range or value of an attribute.
type: integer
allowedPattern:
description: A regex pattern describing an acceptable input pattern.
type: string
allowedValues:
description: A list describing acceptable values.
type: array
items:
type: string
maximumValue:
description: The maximum value allowed for the request.
type: integer
referencedValues:
type: array
items:
type: string
RiskEvaluation:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
createdAt:
type: string
readOnly: true
description: The time the resource was created (format ISO-8061).
details:
$ref: '#/components/schemas/RiskEvaluationDetails'
readOnly: true
description: A details object that provides additional information about the risk evaluation.
environment:
$ref: '#/components/schemas/ObjectEnvironment'
event:
$ref: '#/components/schemas/RiskEvaluationEvent'
description: An object that specifies the attributes to identify the event. This is a required property. For more information about event attributes, see the Event Data Model table.
id:
type: string
readOnly: true
description: A string that specifies the resource’s unique identifier.
riskPolicySet:
type: object
properties:
id:
type: string
description: A string that specifies the risk policy set resource's unique identifier. If the risk policy set ID and name are both specified, the policy set specified by the riskPolicySet.id is used. If the risk policy set ID and name are not specified, the environment's default risk policy set is used.
name:
type: string
description: A string that specifies the risk policy set name associated with this risk evaluation resource. If the risk policy set ID and name are both specified, the policy set specified by the riskPolicySet.id is used. If the risk policy set name and ID are not specified, the environment's default risk policy set is used.
result:
$ref: '#/components/schemas/RiskEvaluationResult'
readOnly: true
description: A result object that specifies the result that corresponds to the risk policy that evaluates as true. If there are several risk policies that evaluate as true, the result that corresponds to the highest priority risk policy is returned. If no risk policy evaluates as true, the result is the defaultResult of the policy set.
updatedAt:
type: string
readOnly: true
description: The time the resource was last updated (format ISO-8061).
required:
- event
RiskEvaluationDetails:
type: object
readOnly: true
properties:
ipAddressReputation:
type: object
properties:
level:
$ref: '#/components/schemas/EnumRiskLevel'
description: A string that specifies the risk level of the evaluated IP address. Options are LOW, MEDIUM, and HIGH. If the score is less than 55, the level is LOW; if the score is greater than 77, the level is HIGH; if the score is between 55 and 77, the level is MEDIUM. Note that these guidelines could change based on data analytics and product consideration. If the ipAddressReputation.score is unknown, NULL is returned.
score:
type: integer
description: An integer that represents the calculated score of the IP address involved in the transaction. Scores range between 0 and 100. A score of 0 indicates a non-risky IP address; a score of 100 indicates a high-risk IP address. If the IP address reputation score is not available for the specific IP address, NULL is returned.
ipVelocityByUser:
type: object
properties:
level:
$ref: '#/components/schemas/EnumRiskLevel'
description: An enum indicating whether the number of distinct IPs for the user in the past hour is flagged as LOW, MEDIUM, or HIGH.
reason:
type: string
description: A string indicating the reason the user was flagged. For example "More than 13 IPs were accessed by John during the last 1 hour."
threshold:
type: object
description: The information about the threshold used.
properties:
high:
type: integer
description: An integer indicating the value calculated for the high threshold. If the user accessed more than the high number of IPs during the past hour, they're flagged as a HIGH ipVelocityByUser.level.
medium:
type: integer
description: An integer indicating the value calculated for the medium threshold. If the user accessed more than the medium number of IPs during the past hour, they're flagged as a MEDIUM ipVelocityByUser.level.
source:
$ref: '#/components/schemas/EnumThresholdSource'
calculatedAt:
type: string
description: A date-time indicating the timestamp for the calculated threshold.
expiresAt:
type: string
description: A date-time indicating when the threshold will be recalculated. The recalculation will happen before this time.
velocity:
type: object
description: Integer values for the measures used to calculate velocity.
properties:
distinctCount:
type: integer
description: This is the distinct count for the previous seconds indicated by the during value.
during:
type: integer
description: The interval (in seconds) during which the velocity is calculated.
userVelocityByIp:
type: object
properties:
level:
$ref: '#/components/schemas/EnumRiskLevel'
description: An enum indicating whether the calculated number of users per IP is LOW, MEDIUM, or HIGH.
reason:
type: string
description: A string indicating the reason the user was flagged. For example "More than 250 users accessed IP address 1.1.1.1 during the last 1 hour."
threshold:
type: object
description: The information about the calculated threshold used.
properties:
high:
type: integer
description: An integer indicating the value calculated for the high threshold. If the IP was accessed by more than the high number of users during the past hour, the IP is flagged as a HIGH userVelocityByIp.level.
medium:
type: integer
description: An integer indicating the value calculated for the medium threshold. If the IP was accessed by more than the medium number of users during the past hour, the IP is flagged as a MEDIUM userVelocityByIp.level
source:
$ref: '#/components/schemas/EnumThresholdSource'
calculatedAt:
type: string
description: A date-time indicating the timestamp for the calculated threshold.
expiresAt:
type: string
description: A date-time indicating when the threshold will be recalculated. The recalculation will happen before this time.
velocity:
type: object
description: Integer values for the measures used to calculate velocity.
properties:
distinctCount:
type: integer
description: Relevant only for predictors having a measure value of "DISTINCT_COUNT". This is the number of users that accessed the IP in the past during seconds.
during:
type: integer
description: The interval (in seconds) during which the velocity is calculated.
impossibleTravel:
type: boolean
description: >-
A boolean that specifies whether the distance between the location of the user in their previous successful authentication and current authentication infers that the user had to travel at a speed greater than 1000 kilometers per hour. This condition is marked as fulfilled, only if:
Location data is available for the current and previous IP address of the user.
This is not the first transaction that the user has performed.
The user’s previous successful transaction was performed less than 24 hours ago.
The user moved a distance of at least 100 kilometers. Thus, even if the user moved very fast, but moved only a distance of 90 kilometers, the condition is not fulfilled.
The user moved at a speed greater than 1000 kilometers per hour.
estimatedSpeed:
type: number
description: The calculated travel speed in units of kilometers per hour.
anonymousNetworkDetected:
type: boolean
description: A boolean that specifies whether the current authentication originated from an anonymous network (for example, proxy or VPN).
country:
type: string
description: A string that specifies the country related to current transaction from the IP address.
state:
type: string
description: A string that specifies the state related to current transaction from the IP address.
city:
type: string
description: A string that specifies the city related to current transaction from the IP address.
longitude:
type: number
description: A double-precision floating point that specifies the longitude related to current transaction from the IP address. Values range from -90 to 90.
latitude:
type: number
description: A double-precision floating point that specifies the latitude related to current transaction from the IP address. Values range from -180 to 180.
previousSuccessfulTransaction:
type: object
properties:
anonymousNetworkDetected:
type: boolean
description: A boolean that specifies whether an anonymous network was detected. Information is available twenty-four hours after the last successful transaction.
country:
type: string
description: A string that specifies the country of the IP address involved in the transaction. Information is available twenty-four hours after the last successful transaction.
state:
type: string
description: A string that specifies the state of the IP address involved in the transaction. Information is available twenty-four hours after the last successful transaction.
city:
type: string
description: A string that specifies the city of the IP address involved in the transaction. Information is available twenty-four hours after the last successful transaction.
ip:
type: string
description: A string that specifies the IP address involved in the transaction. Information is available twenty-four hours after the last successful transaction.
timestamp:
type: string
description: A date that specifies the timestamp of the transaction. Information is available twenty-four hours after the last successful transaction.
userBasedRiskBehavior:
type: object
properties:
level:
$ref: '#/components/schemas/EnumRiskLevel'
description: A string that specifies the risk score calculated for the user behavior for all transactions associated with the accessing device, and for the current authentication attempt. Options are LOW, MEDIUM, and HIGH. This information is available only if customers have agreed to data consent and the intelligence.allowDataConsent property in the PingOne license is set to true.
reason:
type: string
description: A string that describes the reason (or reasons) provided for the user behavior risk score classification (for example, the operating system or browser type used by the device, and country in which the accessing device is located). Each reason is classified as Unusual, to indicate how much it deviates from normal user behavior, and its effect in calculating the overall user behavior risk score.
userRiskBehavior:
type: object
properties:
level:
$ref: '#/components/schemas/EnumRiskLevel'
description: A string that specifies the risk score calculated for the user behavior within the organization associated with the accessing device, and for the current authentication attempt. Options are LOW, MEDIUM, and HIGH. This information is available only if customers have agreed to data consent and the intelligence.allowDataConsent property in the PingOne license is set to true.
reason:
type: string
description: A string that describes the reason (or reasons) provided for the user behavior risk score classification within the organization (for example, the operating system or browser type used by the device, and country in which the accessing device is located). Each reason is classified as Unusual or Very Unusual, to indicate how much it deviates from normal user behavior, and its effect in calculating the overall user behavior risk score.
RiskEvaluationEvent:
type: object
properties:
browser:
type: object
description: An object that specifies the browser fingerprint attributes. Browser data can be retrieved using browser fingerprint JS. For more information, see Overview of the PingOne Risk Integration Kit.
properties:
userAgent:
type: string
cookie:
type: string
language:
type: string
colorDepth:
type: number
deviceMemory:
type: number
hardwareConcurrency:
type: number
screenResolution:
type: array
items:
type: number
availableScreenResolution:
type: array
items:
type: number
timezoneOffset:
type: number
timezone:
type: string
sessionStorage:
type: boolean
localStorage:
type: boolean
indexedDb:
type: boolean
addBehaviour:
type: object
openDatabase:
type: boolean
cpuClass:
type: string
platform:
type: string
plugins:
type: array
items:
type: object
webglVendorAndRenderer:
type: string
webgl:
type: array
items:
type: string
adBlock:
type: boolean
hasLiedLanguages:
type: boolean
hasLiedResolution:
type: boolean
hasLiedOs:
type: boolean
hasLiedBrowser:
type: boolean
touchSupport:
type: array
items:
type: string
fonts:
type: array
items:
type: string
audio:
type: string
completionStatus:
$ref: '#/components/schemas/EnumCompletionStatus'
evaluatedFactors:
type: object
properties:
status:
$ref: '#/components/schemas/EnumCompletionStatus'
type:
type: string
description: A string that specifies the transaction type.
ip:
type: string
description: A string that specifies the origin IP address of the authentication flow. This is a required property.
flow:
type: object
properties:
type:
$ref: '#/components/schemas/EnumFlowType'
origin:
type: string
description: A string that specifies the calling service.
session:
type: object
properties:
id:
type: string
description: A string that specifies a unique session ID associated with the event.
required:
- id
targetResource:
type: object
properties:
id:
type: string
description: A string that specifies the ID of the target application.
name:
type: string
description: A string that specifies the name of the target application.
user:
type: object
properties:
id:
type: string
description: A string that specifies the ID of the user associated with the event (maximum size 1024 characters). This is a required property.
name:
type: string
description: A string that specifies the name of the user associated with the event (maximum size 1024 characters).
type:
$ref: '#/components/schemas/EnumUserType'
groups:
type: array
description: An array of group names.
items:
type: object
properties:
name:
type: string
description: A string that specifies the name of the group (maximum size 1024 characters).
required:
- id
- type
sharingType:
$ref: '#/components/schemas/EnumEventSharingType'
required:
- ip
- user
RiskEvaluationResult:
type: object
properties:
type:
$ref: '#/components/schemas/EnumResultType'
readOnly: true
level:
$ref: '#/components/schemas/EnumRiskLevel'
readOnly: true
description: A string that specifies the risk evaluation result level. Options are HIGH, MEDIUM, and LOW.
value:
type: string
readOnly: true
description: A string that specifies any custom attribute the administrator defines.
RiskPolicy:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
condition:
type: object
description: Contains the condition logic that determines when a policy is evaluated to true and when it is evaluated to false.
properties:
type:
$ref: '#/components/schemas/EnumRiskPolicyConditionType'
contains:
type: string
ipRange:
type: array
items:
type: string
value:
type: string
equals:
oneOf:
- type: string
- type: boolean
aggregatedWeights:
type: array
description: Required for weights-based policies. The elements in the array are `value`-`weight` pairs, representing a weighting for the weighted average calculation that should be assigned to a specific predictor when it is determined that there is a high risk for the predictor.
items:
type: object
properties:
value:
type: string
description: Text that identifies a specific risk predictor in the environment. It uses the form `${details.xxxxxxx.level}`, where the string between `details` and `level` is the compact name of the relevant predictor.
weight:
type: integer
description: The score you want to assign to the predictor when it is determined that there is a high risk for the predictor. Value should be between 0 and 100. If it is determined that there is medium risk, the predictor will automatically be assigned a score equal to half of the value you specified for high risk.
required:
- value
- weight
aggregatedScores:
type: array
description: Required for score-based policies. The elements in the array are `value`-`score` pairs, representing the score that should be assigned to a specific predictor when it is determined that there is a high risk for the predictor.
items:
type: object
properties:
value:
type: string
description: Text that identifies a specific risk predictor in the environment. It uses the form `${details.xxxxxxx.level}`, where the string between `details` and `level` is the compact name of the relevant predictor.
score:
type: integer
description: The score you want to assign to the predictor when it is determined that there is a high risk for the predictor. Value should be between 0 and 100. If it is determined that there is medium risk, the predictor will automatically be assigned a score equal to half of the value you specified for high risk.
required:
- value
- score
between:
type: object
properties:
minScore:
type: integer
description: Required for policies of type `AGGREGATED_SCORES` or `AGGREGATED_WEIGHTS`. The beginning of the risk score range that will be translated into the specified risk level (`MEDIUM` or `HIGH`). Must be between `0` and `1000`.
minimum: 0
maximum: 1000
maxScore:
type: integer
description: Required for policies of type `AGGREGATED_SCORES` or `AGGREGATED_WEIGHTS`. The end of the risk score range that will be translated into the specified risk level (`MEDIUM` or `HIGH`). Must be between `0` and `1000`.
minimum: 0
maximum: 1000
required:
- minScore
- maxScore
createdAt:
type: string
format: date-time
readOnly: true
description: The time the resource was first created (format ISO-8061).
description:
type: string
description: A string that specifies a description for this risk policy. This is an optional property. Valid characters consist of any Unicode letter, mark (for example, accent, umlaut), numeric character, punctuation character, or space. Maximum size is 1024 characters.
environment:
$ref: '#/components/schemas/ObjectEnvironment'
id:
type: string
readOnly: true
description: A string that specifies the resource’s unique identifier.
name:
type: string
description: A string that specifies a name for this risk policy. Valid characters consist of any Unicode letter, mark (for example, accent, umlaut), numeric character, forward slash, dot, apostrophe, underscore, space, or hyphen. Maximum size is 256 characters.
priority:
type: integer
description: An integer that specifies priority of the policy inside a risk policy set, designating which policy should run first. This is a read-only value. The priority is determined by the order in which policies are listed in the policy set. The first policy in the list is assigned priority 1 and is evaluated first. The next policy in the list is assigned priority 2 and so on.
result:
$ref: '#/components/schemas/RiskPolicyResult'
updatedAt:
type: string
format: date-time
readOnly: true
description: The time the resource was last updated (format ISO-8061).
required:
- name
- result
- condition
RiskPolicySet:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
createdAt:
type: string
format: date-time
readOnly: true
description: The time the resource was created (format ISO-8061).
default:
type: boolean
description: A boolean that specifies whether this risk policy set is the environment's default risk policy set, which is used whenever an explicit policySet ID is not specified in the risk policy evaluation request. If this property is not specified, the value defaults to false, and this risk policy set is not regarded as the default risk policy set for the environment. When this property is set to true (in PUT or POST requests), the default property of all other risk policy sets in the environment is set to false.
defaultResult:
type: object
description: A result object that specifies the default result returned if none of the conditions in the policy set are evaluated to true. At this time, the defaultResultLevel value must be LOW.
properties:
level:
$ref: '#/components/schemas/EnumRiskPolicyResultLevel'
type:
$ref: '#/components/schemas/EnumResultType'
required:
- level
description:
type: string
description: A string that specifies a description for this policy set. This is an optional property. Valid characters consist of any Unicode letter, mark (for example, accent, umlaut), numeric character, punctuation character, or space. Maximum size is 1024 characters.
environment:
$ref: '#/components/schemas/ObjectEnvironment'
id:
type: string
readOnly: true
description: A string that specifies the resource’s unique identifier.
name:
type: string
description: A string that specifies a name for this policy set. Valid characters consist of any Unicode letter, mark (for example, accent, umlaut), numeric character, forward slash, dot, apostrophe, underscore, space, or hyphen. Maximum size is 256 characters.
riskPolicies:
type: array
description: An array of policies related to this policy set.
items:
$ref: '#/components/schemas/RiskPolicy'
updatedAt:
type: string
format: date-time
readOnly: true
description: The time the resource was last updated (format ISO-8061).
evaluatedPredictors:
type: array
description: The IDs for the predictors to evaluate in this policy set. In POST and PUT requests, if this property is null, all of the licensed predictors are used.
items:
type: object
properties:
id:
type: string
description: A string that specifies the resource’s unique identifier.
required:
- id
triggers:
type: array
description: An array of triggers related to this policy set.
items:
type: object
properties:
type:
$ref: '#/components/schemas/EnumRiskPolicySetTriggerType'
policySet:
type: object
properties:
id:
type: string
description: A string that specifies the resource’s unique identifier.
required:
- id
expiresAt:
type: string
format: date-time
description: The time the trigger expires (format ISO-8061).
required:
- type
- policySet
- expiresAt
required:
- name
RiskPolicyResult:
type: object
description: A result object that specifies the result returned if the policy is evaluated as true. If several policies are evaluated as true, the result related to the highest priority policy is returned. for more information, see the Result attribute data model in the Risk Evaluations topic.
properties:
level:
$ref: '#/components/schemas/EnumRiskLevel'
type:
$ref: '#/components/schemas/EnumResultType'
value:
type: string
required:
- level
RiskPredictor:
oneOf:
- $ref: '#/components/schemas/RiskPredictorAdversaryInTheMiddle'
- $ref: '#/components/schemas/RiskPredictorAnonymousNetwork'
- $ref: '#/components/schemas/RiskPredictorBotDetection'
- $ref: '#/components/schemas/RiskPredictorComposite'
- $ref: '#/components/schemas/RiskPredictorCustom'
- $ref: '#/components/schemas/RiskPredictorDevice'
- $ref: '#/components/schemas/RiskPredictorEmailReputation'
- $ref: '#/components/schemas/RiskPredictorGeovelocity'
- $ref: '#/components/schemas/RiskPredictorIPReputation'
- $ref: '#/components/schemas/RiskPredictorTrafficAnomaly'
- $ref: '#/components/schemas/RiskPredictorUserLocationAnomaly'
- $ref: '#/components/schemas/RiskPredictorUserRiskBehavior'
- $ref: '#/components/schemas/RiskPredictorVelocity'
discriminator:
propertyName: type
mapping:
ADVERSARY_IN_THE_MIDDLE: '#/components/schemas/RiskPredictorAdversaryInTheMiddle'
ANONYMOUS_NETWORK: '#/components/schemas/RiskPredictorAnonymousNetwork'
BOT: '#/components/schemas/RiskPredictorBotDetection'
COMPOSITE: '#/components/schemas/RiskPredictorComposite'
DEVICE: '#/components/schemas/RiskPredictorDevice'
EMAIL_REPUTATION: '#/components/schemas/RiskPredictorEmailReputation'
GEO_VELOCITY: '#/components/schemas/RiskPredictorGeovelocity'
IP_REPUTATION: '#/components/schemas/RiskPredictorIPReputation'
MAP: '#/components/schemas/RiskPredictorCustom'
TRAFFIC_ANOMALY: '#/components/schemas/RiskPredictorTrafficAnomaly'
USER_LOCATION_ANOMALY: '#/components/schemas/RiskPredictorUserLocationAnomaly'
USER_RISK_BEHAVIOR: '#/components/schemas/RiskPredictorUserRiskBehavior'
VELOCITY: '#/components/schemas/RiskPredictorVelocity'
RiskPredictorCommon:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
id:
type: string
readOnly: true
description: A string that specifies the resource’s unique identifier.
name:
type: string
description: A string type. A unique, friendly name for the predictor. This name is displayed in the Risk Policies UI, when the admin is asked to define the overrides and weights.
compactName:
type: string
description: A string type. A unique name for the predictor. This property is immutable; it cannot be modified after initial creation. The value must be alpha-numeric, with no special characters or spaces. This name is used in the API both for policy configuration, and in the Risk Evaluation response (under details).
format: ^[a-zA-Z0-9]+$
type:
$ref: '#/components/schemas/EnumPredictorType'
description:
type: string
description: A string type. This specifies the description of the risk predictor. Maximum length is 1024 characters.
maxLength: 1024
createdAt:
type: string
format: date-time
readOnly: true
description: The time the resource was created.
updatedAt:
type: string
format: date-time
readOnly: true
description: The time the resource was updated.
licensed:
type: boolean
readOnly: true
description: Indicates whether PingOne Risk is licensed for the environment.
deletable:
type: boolean
readOnly: true
description: A boolean to indicate whether the predictor is deletable in the environment.
default:
type: object
description: Contains the default values used for a new risk predictor.
properties:
weight:
type: integer
description: An integer type. This specifies the weight assigned to the risk predictor in a new policy by default.
score:
type: integer
evaluated:
type: boolean
result:
type: object
description: >-
This specifies the result assigned to the predictor if the predictor could not be calculated during the risk evaluation. If this field is not provided, and the predictor could not be calculated during risk evaluation, the following options are:
If the predictor is used in an override, the override is skipped.
In the weighted policy, the predictor will have a weight of 0.
properties:
level:
$ref: '#/components/schemas/EnumRiskLevel'
type:
$ref: '#/components/schemas/EnumResultType'
required:
- type
required:
- weight
condition:
type: object
readOnly: true
properties:
scores:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
required:
- name
- compactName
- type
RiskPredictorAdversaryInTheMiddle:
allOf:
- $ref: '#/components/schemas/RiskPredictorCommon'
- type: object
properties:
domainWhiteList:
type: array
description: A list of strings that specify legitimate domains that users will access for restricted resources.
items:
type: string
RiskPredictorAnonymousNetwork:
allOf:
- $ref: '#/components/schemas/RiskPredictorCommon'
- type: object
properties:
whiteList:
type: array
description: A list of IP addresses (CIDRs) that are ignored for the predictor results.
items:
type: string
format: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}$
RiskPredictorBotDetection:
allOf:
- $ref: '#/components/schemas/RiskPredictorCommon'
- type: object
properties:
includeRepeatedEventsWithoutSdk:
type: boolean
description: Set the value of `includeRepeatedEventsWithoutSdk` to `true` to expand the range of bot activity that PingOne Protect can detect.
RiskPredictorComposite:
allOf:
- $ref: '#/components/schemas/RiskPredictorCommon'
- type: object
properties:
composition:
type: object
deprecated: true
properties:
condition:
$ref: '#/components/schemas/RiskPredictorCompositeConditionBase'
level:
$ref: '#/components/schemas/EnumRiskLevel'
required:
- condition
- level
compositions:
type: array
description: Contains the objects that specify the conditions to test and the risk level that should be assigned if the conditions are met. The array can contain a maximum of three elements.
items:
properties:
condition:
$ref: '#/components/schemas/RiskPredictorCompositeConditionBase'
level:
$ref: '#/components/schemas/EnumRiskLevel'
required:
- condition
- level
required:
- compositions
RiskPredictorCompositeAnd:
type: object
properties:
and:
type: array
items:
$ref: '#/components/schemas/RiskPredictorCompositeCondition'
type:
$ref: '#/components/schemas/EnumPredictorCompositeConditionType'
required:
- and
RiskPredictorCompositeConditionBase:
oneOf:
- $ref: '#/components/schemas/RiskPredictorCompositeNot'
- $ref: '#/components/schemas/RiskPredictorCompositeAnd'
- $ref: '#/components/schemas/RiskPredictorCompositeOr'
discriminator:
propertyName: type
mapping:
NOT: '#/components/schemas/RiskPredictorCompositeNot'
AND: '#/components/schemas/RiskPredictorCompositeAnd'
OR: '#/components/schemas/RiskPredictorCompositeOr'
RiskPredictorCompositeCondition:
oneOf:
- $ref: '#/components/schemas/RiskPredictorCompositeNot'
- $ref: '#/components/schemas/RiskPredictorCompositeOr'
- $ref: '#/components/schemas/RiskPredictorCompositeAnd'
- type: object
properties:
contains:
type: string
format: ^\${(event|details)[a-z\.]+}$
list:
type: array
items:
type: string
type:
$ref: '#/components/schemas/EnumPredictorCompositeConditionType'
required:
- contains
- list
- type
- type: object
properties:
equals:
oneOf:
- type: string
- type: integer
notEquals:
oneOf:
- type: string
- type: integer
greater:
type: integer
greaterEquals:
type: integer
lower:
type: integer
lowerEquals:
type: integer
value:
type: string
format: ^\${(event|details)[a-z\.]+}$
type:
$ref: '#/components/schemas/EnumPredictorCompositeConditionType'
required:
- value
RiskPredictorCompositeNot:
type: object
properties:
not:
$ref: '#/components/schemas/RiskPredictorCompositeOr'
type:
$ref: '#/components/schemas/EnumPredictorCompositeConditionType'
required:
- not