-
Notifications
You must be signed in to change notification settings - Fork 0
/
pingone-verify.yml
1184 lines (1184 loc) · 35.9 KB
/
pingone-verify.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.0.0
info:
title: PingOne Platform API - PingOne Verify
description: The PingOne Platform API covering the PingOne Verify service
version: '2023-07-20'
externalDocs:
url: https://apidocs.pingidentity.com/pingone/platform/v1/api/#pingone-verify
description: PingOne Platform API Reference - PingOne Verify 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:
type: object
readOnly: true
additionalProperties: true
properties:
self:
type: object
description: An object that describes the current resource.
properties:
href:
$ref: '#/components/schemas/LinksHATEOASHref'
next:
type: object
description: An object that describes the next page of results. This property is present only if there is a next page of results and the `limit` parameter is used.
properties:
href:
$ref: '#/components/schemas/LinksHATEOASHref'
LinksHATEOASHref:
type: string
format: uri
description: The URI of the resource.
EntityArray:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
'_embedded':
type: object
properties:
verifyPolicies:
type: array
items:
$ref: '#/components/schemas/VerifyPolicy'
voicePhrases:
type: array
items:
$ref: '#/components/schemas/VoicePhrase'
contents:
type: array
items:
$ref: '#/components/schemas/VoicePhraseContents'
size:
type: number
EnumInspectionType:
type: string
enum: [AUTOMATIC, MANUAL, STEP_UP]
description: A string that defines the mechanism used to authenticate a `governmentId` document. Options are `AUTOMATIC`, `MANUAL`, or `STEP_UP`.
EnumTimeUnit:
type: string
enum: [SECONDS, MINUTES]
description: A string that defines the time unit of a specified duration in `SECONDS` or `MINUTES`.
EnumThreshold:
type: string
enum: [LOW, MEDIUM, HIGH]
description: A string that defines the verification comparison threshold. Options are `LOW`, `MEDIUM` and `HIGH`.
EnumVerify:
type: string
enum: [REQUIRED, OPTIONAL, DISABLED]
description: A string that defines the verification check requirements. Options are `REQUIRED`, `OPTIONAL` and `DISABLED`.
FacialComparisonConfiguration:
type: object
properties:
verify:
$ref: '#/components/schemas/EnumVerify'
description: Controls if facial comparison is REQUIRED, OPTIONAL, or DISABLED.
threshold:
$ref: '#/components/schemas/EnumThreshold'
description: Threshold for successful facial comparison; can be LOW, MEDIUM, or HIGH (for which PingOne Verify uses industry and vendor recommended definitions).
required:
- threshold
- verify
GovernmentIdConfiguration:
type: object
properties:
inspectionType:
$ref: '#/components/schemas/EnumInspectionType'
description: Determines whether document authentication is automated, manual, or a combination of both where manual authentication is performed if automated inspection fails. Can be AUTOMATIC, MANUAL, or STEP_UP.
verify:
$ref: '#/components/schemas/EnumVerify'
description: Controls if Government ID verification is REQUIRED, OPTIONAL, or DISABLED.
required:
- verify
LivenessConfiguration:
type: object
properties:
verify:
$ref: '#/components/schemas/EnumVerify'
description: Controls if liveness check is REQUIRED, OPTIONAL, or DISABLED.
threshold:
$ref: '#/components/schemas/EnumThreshold'
description: Threshold for successful facial comparison; can be LOW, MEDIUM, or HIGH (for which PingOne Verify uses industry and vendor recommended definitions).
required:
- threshold
- verify
ObjectEnvironment:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the environment associated with the object.
OTPDeviceConfiguration:
type: object
properties:
verify:
$ref: '#/components/schemas/EnumVerify'
description: Controls if email or phone verification is REQUIRED, OPTIONAL, or DISABLED.
createMfaDevice:
type: boolean
description: When enabled, PingOne Verify registers the email address or phone number with PingOne MFA as a verified MFA device.
otp:
type: object
properties:
attempts:
type: object
description: OTP attempts configuration.
properties:
count:
type: integer
description: Count of OTP failures.
required:
- count
deliveries:
type: object
description: OTP delivery configuration.
properties:
count:
type: integer
description: Count of OTP deliveries.
cooldown:
type: object
description: Cooldown (waiting period between OTP attempts) configuration.
properties:
duration:
type: integer
description: Cooldown duration configuration.
timeUnit:
$ref: '#/components/schemas/EnumTimeUnit'
description: Time unit of cooldown duration. Options are SECONDS or MINUTES.
required:
- duration
- timeUnit
required:
- count
- cooldown
lifeTime:
type: object
description: The length of time for which the OTP is valid.
properties:
duration:
type: integer
description: OTP duration configuration.
timeUnit:
$ref: '#/components/schemas/EnumTimeUnit'
description: Time unit of OTP duration configuration. Options are SECONDS or MINUTES.
required:
- duration
- timeUnit
notification:
type: object
description: OTP notification template configuration.
properties:
templateName:
type: string
variantName:
type: string
required:
- templateName
required:
- attempts
- lifeTime
- deliveries
- notification
required:
- verify
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
TransactionConfiguration:
type: object
properties:
timeout:
type: object
properties:
duration:
type: integer
description: Length of time before transaction timeout expires; range is 0-30 minutes or 0-1800 seconds.
timeUnit:
$ref: '#/components/schemas/EnumTimeUnit'
description: Time unit of transaction timeout; can be SECONDS, MINUTES.
required:
- duration
- timeUnit
dataCollection:
type: object
properties:
timeout:
type: object
properties:
duration:
type: integer
description: Length of time before data collection timeout expires; range is 0-30 minutes or 0-1800 seconds.
timeUnit:
$ref: '#/components/schemas/EnumTimeUnit'
description: Time unit of transaction timeout; can be SECONDS, MINUTES.
required:
- duration
- timeUnit
required:
- timeout
dataCollectionOnly:
type: boolean
VoiceConfiguration:
example:
verify: null
enrollment: true
textDependent:
samples: null
phrase:
id: id
comparison:
threshold: null
liveness:
threshold: null
referenceData:
retainOriginalRecordings: true
updateOnReenrollment: true
updateOnVerification: true
properties:
verify:
$ref: '#/components/schemas/EnumVerify'
enrollment:
type: boolean
textDependent:
$ref: '#/components/schemas/VoiceConfiguration_textDependent'
comparison:
properties:
$ref: '#/components/schemas/VoiceConfiguration_threshold'
liveness:
$ref: '#/components/schemas/VoiceConfiguration_threshold'
referenceData:
$ref: '#/components/schemas/VoiceConfiguration_referenceData'
required:
- verify
- enrollment
- comparison
- liveness
type: object
VoiceConfiguration_referenceData:
example:
retainOriginalRecordings: true
updateOnReenrollment: true
updateOnVerification: true
properties:
retainOriginalRecordings:
type: boolean
updateOnReenrollment:
type: boolean
updateOnVerification:
type: boolean
type: object
VoiceConfiguration_threshold:
example:
threshold: null
properties:
threshold:
$ref: '#/components/schemas/EnumThreshold'
required:
- threshold
type: object
VoiceConfiguration_textDependent_phrase:
example:
id: id
properties:
id:
type: string
required:
- id
type: object
VoiceConfiguration_textDependent:
example:
samples: null
phrase:
id: id
properties:
samples:
type: integer
phrase:
$ref: '#/components/schemas/VoiceConfiguration_textDependent_phrase'
required:
- samples
- phrase
type: object
VoicePhrase:
properties:
id:
type: string
readOnly: true
environment:
$ref: '#/components/schemas/ObjectEnvironment'
displayName:
type: string
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
required:
- displayName
type: object
VoicePhraseContents:
properties:
id:
type: string
readOnly: true
environment:
$ref: '#/components/schemas/ObjectEnvironment'
voicePhrase:
properties:
id:
type: string
required:
- id
locale:
type: string
content:
type: string
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
required:
- locale
- content
- voicePhrase
type: object
VerifyPolicy:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
id:
type: string
readOnly: true
environment:
$ref: '#/components/schemas/ObjectEnvironment'
name:
type: string
description: Name displayed in PingOne Admin UI.
description:
type: string
description: Description displayed in PingOne Admin UI, 1-1024 characters.
default:
type: boolean
description: Required as true to set this verify policy as the default policy for the environment; otherwise optional and defaults to false.
governmentId:
$ref: '#/components/schemas/GovernmentIdConfiguration'
facialComparison:
$ref: '#/components/schemas/FacialComparisonConfiguration'
liveness:
$ref: '#/components/schemas/LivenessConfiguration'
email:
$ref: '#/components/schemas/OTPDeviceConfiguration'
phone:
$ref: '#/components/schemas/OTPDeviceConfiguration'
transaction:
$ref: '#/components/schemas/TransactionConfiguration'
voice:
$ref: '#/components/schemas/VoiceConfiguration'
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
required:
- name
responses:
'400':
description: Invalid request received. Malformed JSON, malformed HTTP request.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'401':
description: Request failed due to authorization issue.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'403':
description: Request failed due to authorization issue.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'404':
description: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'405':
description: Invalid request received. Malformed JSON, malformed HTTP request.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'409':
description: Conflict.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'429':
description: Request was rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'500':
description: Uncaught error occurred. Platform outage
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
security:
- bearer: []
tags:
- name: Verify Policies
paths:
/environments/{environmentID}/verifyPolicies:
post:
tags:
- Verify Policies
summary: CREATE Verify Policy
operationId: createVerifyPolicy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyPolicy'
example:
name: Example Verify Policy
default: false
description: All types required
email:
createMfaDevice: true
otp:
attempts:
count: 5
deliveries:
cooldown:
duration: 30
timeUnit: SECONDS
count: 3
lifeTime:
duration: 10
timeUnit: MINUTES
notification:
templateName: email_phone_verification
verify: REQUIRED
facialComparison:
threshold: HIGH
verify: REQUIRED
governmentId:
verify: REQUIRED
liveness:
threshold: HIGH
verify: REQUIRED
phone:
createMfaDevice: true
otp:
attempts:
count: 5
deliveries:
cooldown:
duration: 30
timeUnit: SECONDS
count: 3
lifeTime:
duration: 10
timeUnit: MINUTES
notification:
templateName: email_phone_verification
verify: REQUIRED
transaction:
dataCollection:
timeout:
duration: 15
timeUnit: MINUTES
dataCollectionOnly: false
timeout:
duration: 30
timeUnit: MINUTES
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'201':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyPolicy'
get:
tags:
- Verify Policies
summary: READ All Verify Policies
operationId: readAllVerifyPolicies
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EntityArray'
/environments/{environmentID}/verifyPolicies/{verifyPolicyID}:
get:
tags:
- Verify Policies
summary: READ One Verify Policy
operationId: readOneVerifyPolicy
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: verifyPolicyID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyPolicy'
put:
tags:
- Verify Policies
summary: UPDATE Verify Policy
operationId: updateVerifyPolicy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyPolicy'
example:
default: false
description: Verify Government ID and compare Selfie
facialComparison:
threshold: HIGH
verify: REQUIRED
governmentId:
verify: REQUIRED
liveness:
threshold: HIGH
verify: REQUIRED
name: Identity Verification
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: verifyPolicyID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/VerifyPolicy'
delete:
tags:
- Verify Policies
summary: Delete Verify Policy
operationId: deleteVerifyPolicy
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: verifyPolicyID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'204':
description: Successful response
/environments/{environmentID}/voicePhrases:
post:
tags:
- Voice Phrases
summary: CREATE Voice Phrase
operationId: createVoicePhrase
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoicePhrase'
example:
displayName: 'Example Voice Phrase'
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'201':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/VoicePhrase'
get:
tags:
- Voice Phrases
summary: READ All Voice Phrases
operationId: readAllVoicePhrases
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EntityArray'
/environments/{environmentID}/voicePhrases/{voicePhraseID}:
get:
tags:
- Voice Phrases
summary: READ One Voice Phrase
operationId: readOneVoicePhrase
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: voicePhraseID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/VoicePhrase'
put:
tags:
- Voice Phrases
summary: UPDATE Voice Phrase
operationId: updateVoicePhrase
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoicePhrase'
example:
displayName: Voice Phrase Name
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: voicePhraseID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/VoicePhrase'
delete:
tags:
- Voice Phrases
summary: Delete Voice Phrase
operationId: deleteVoicePhrase
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: voicePhraseID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'204':
description: Successful response
/environments/{environmentID}/voicePhrases/{voicePhraseID}/contents:
post:
tags:
- Voice Phrase Contents
summary: CREATE Voice Phrase Content
operationId: createVoicePhraseContent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VoicePhraseContents'
example:
locale: en
content: 'Design brilliant journeys to any digital desintation.'
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: voicePhraseID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'