-
Notifications
You must be signed in to change notification settings - Fork 1
/
pingone-credentials.yml
2308 lines (2308 loc) · 72.8 KB
/
pingone-credentials.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 - Credentials
description: The PingOne Platform API covering the PingOne Credentials service
version: '2023-06-29'
externalDocs:
url: https://apidocs.pingidentity.com/pingone/platform/v1/api/#pingone-credentials
description: PingOne Platform API Reference - Credentials 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:
type: object
properties:
href:
type: string
format: uri
description: The HREF of the link.
required:
- href
EnumCredentialTypeManagementMode:
type: string
enum: [AUTOMATED, MANAGED]
description: Specifies the mechanism used to manage the lifecycle of the credential type.
EnumCredentialTypeMetaDataFieldsFileSupport:
type: string
enum: [BASE64_STRING, INCLUDE_FILE, REFERENCE_FILE]
description: |
Specifies the type of data in the defined field within a credential type:
`BASE64_STRING` - indicates the image stored in the field is base64-encoded and is stored directly in the credential
`INCLUDE_FILE` - indicates the image stored in the field is binary and is stored directly in the credential
`REFERENCE_FILE` - indicates the value is a URL referencing an image is in the credential and the image binary remains stored external to the credential
EnumCredentialTypeMetaDataFieldsType:
type: string
enum: [Alphanumeric Text, Issued Timestamp, Directory Attribute]
description: |
Specifies the type of data in the defined field within a credential type:
`Alphanumeric Text` - static text string of letters, numbers, or punctuation set on fields.value
`Issued Timestamp` - date and time the credential was issued
`Directory Attribute` - any PingOne Directory standard or custom attribute.
EnumCredentialIssuanceRuleAutomationMethod:
type: string
enum: [PERIODIC, ON_DEMAND]
description: |
Specifies the method the service uses to issue, revoke, or update credentials with the credential issuance rule:
`PERIODIC` - the issuance rule is invoked by the credentials service on a scheduled interval
`ON_DEMAND` - the issuance rule is invoked in real-time by the calling service applying staged changes.
EnumCredentialIssuanceRuleNotificationMethod:
type: string
enum: [SMS, EMAIL]
description: Specifies the method for notifying the user; can be SMS, EMAIL or both.
EnumCredentialIssuanceRuleStatus:
type: string
enum: [ACTIVE, DISABLED]
description: Specifies the ACTIVE or DISABLED status of the credential issuance rule.
EnumCredentialIssuanceRuleStagedChangeAction:
type: string
enum: [ISSUE, UPDATE, REVOKE]
description: Specifies the ISSUE, UPDATE, or REVOKE action determined by the service that should be taken for the credential based on the request that staged it.
EnumCDigitalWalletProvisionedCredentialWalletAction:
type: string
enum: [CREDENTIAL_ACCEPTED, CREDENTIAL_REJECTED, CREDENTIAL_REVOKED, CREDENTIAL_DELETED]
description: Specifies the action taken regarding the provisioned credentia.
CredentialIssuerProfile:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
applicationInstance:
type: object
properties:
id:
type: string
description: A string that specifies the identifier (UUID) of the application instance registered with the PingOne platform service.
readOnly: true
createdAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the issuer profile was created.
environment:
$ref: '#/components/schemas/ObjectEnvironment'
id:
type: string
description: A string that specifies the identifier (UUID) of the credential issuer.
readOnly: true
name:
type: string
description: The name of the credential issuer. This will be included in credentials issued.
updatedAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential issuer profile was last updated; can be null.
siteUrl:
type: string
description: A string that specifies the base URL associated with the credential issuer.
customEmailTemplate:
type: string
description: A string that specifies the default notification template used in credential issuance notifications. Deprecated.
required:
- name
CredentialTypeMetaData:
type: object
properties:
backgroundImage:
type: string
description: A string that specifies the URL to an image of the background to show in the credential.
bgOpacityPercent:
type: integer
description: A string that specifies the percent opacity of the background image in the credential. High percentage opacity may make reading text difficult.
cardColor:
type: string
description: A string that specifies the color to show on the credential.
columns:
type: integer
description: An integer value between 1-3 that specifies the vertical layout of displayed fields in the credential type.
description:
type: string
description: A string that specifies the description of the credential.
fields:
type: array
description: An array of objects that specifies the fields on the credential.
items:
type: object
properties:
attribute:
type: string
description: A string that specifies the name of the PingOne Directory attribute if field.type is Directory Attribute.
default:
type: string
description: Assigns a default field value if a PingOne Expression Language (PEL) expression in the fields.attribute evaluates to no value.
id:
type: string
description: A string that specifies the identifier of the field.
fileSupport:
$ref: '#/components/schemas/EnumCredentialTypeMetaDataFieldsFileSupport'
isVisible:
type: boolean
description: A boolean value that specifies whether the field should be visible to viewers of the credential.
required:
type: boolean
description: A boolean value that specifies whether the field is required for the credential.
title:
type: string
description: A string that specifies the descriptive text when showing the field.
type:
$ref: '#/components/schemas/EnumCredentialTypeMetaDataFieldsType'
value:
type: string
description: A string that specifies the text to appear on the credential for a type of Alphanumeric Text.
required:
- id
- title
- isVisible
- type
logoImage:
type: string
description: A string that specifies the URL to an image of the logo to show in the credential.
name:
type: string
description: A string that specifies the name of the credential.
textColor:
type: string
description: A string that specifies the color of the text to show on the credential.
version:
type: integer
description: An integer that specifies the version of this credential. If not provided, the service assigns a version.
CredentialType:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
cardDesignTemplate:
type: string
description: A string that specifies an SVG formatted image containing placeholders for the credential fields that need to be displayed in the image.
cardType:
type: string
description: A string that specifies the descriptor of the credential type. Can be non-identity types such as proof of employment or proof of insurance.
createdAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential type was created.
description:
type: string
description: A string that specifies the description of the credential type.
deletedAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential type was deleted. Note - a deletion of a credential type is a "soft delete".
environment:
$ref: '#/components/schemas/ObjectEnvironment'
id:
type: string
readOnly: true
description: A string that specifies the identifier (UUID) associated with the credential type.
issuer:
$ref: '#/components/schemas/ObjectIssuer'
issuerName:
type: string
description: A string that specifies the issuer name associated with the card, can differ from title.
management:
type: object
properties:
mode:
$ref: '#/components/schemas/EnumCredentialTypeManagementMode'
metadata:
$ref: '#/components/schemas/CredentialTypeMetaData'
multiple:
type: object
description: An object containing directives that enable the issuance of multiple credentials to a user based on a directory attribute.
properties:
expression:
type: string
description: A PingOne Expression Language (PEL) expression evaluated by the P1 Credentials service on issuance.If an array, calculates the array length for the count. Populates the limit to a variable, __ITERATOR__, available to PEL expressions in metadata.fields.attribute.
required:
- expression
onDelete:
type: object
properties:
revokeIssuedCredentials:
type: boolean
description: A boolean that specifies whether a user's issued verifiable credentials are automatically revoked when a credential type, user, or environment is deleted.
title:
type: string
description: A string that specifies the title of the credential. Verification sites are expected to be able to request the issued credential from the compatible wallet app using the title.
updatedAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential type was last updated; can be null.
required:
- cardDesignTemplate
- metadata
- title
CredentialIssuanceRule:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
automation:
type: object
properties:
issue:
$ref: '#/components/schemas/EnumCredentialIssuanceRuleAutomationMethod'
update:
$ref: '#/components/schemas/EnumCredentialIssuanceRuleAutomationMethod'
revoke:
$ref: '#/components/schemas/EnumCredentialIssuanceRuleAutomationMethod'
required:
- issue
- update
- revoke
createdAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential issuance rule was created.
credentialType:
type: object
properties:
id:
type: string
readOnly: true
description: A string that specifies the iIdentifier (UUID) of the credential type with which this credential issuance rule is associated.
digitalWalletApplication:
type: object
properties:
id:
type: string
description: A string that specifies the identifier (UUID) of the customer's Digital Wallet App that will interact with the user's Digital Wallet.
required:
- id
environment:
$ref: '#/components/schemas/ObjectEnvironment'
filter:
type: object
properties:
groupIds:
type: array
items:
type: string
populationIds:
type: array
items:
type: string
scim:
type: string
id:
type: string
readOnly: true
description: A string that specifies the identifier (UUID) of the credential issuance rule.
notification:
type: object
properties:
methods:
type: array
items:
$ref: '#/components/schemas/EnumCredentialIssuanceRuleNotificationMethod'
template:
type: object
properties:
locale:
type: string
description: A string that specifies the ISO 2-character language code used for the notification; for example, en.
variables:
type: object
description: An object of key:value pairs that defines the dynamic variables used by the content variant.
variant:
type: string
description: A string that specifies the unique user-defined name for the content variant that contains the message text used for the notification
status:
$ref: '#/components/schemas/EnumCredentialIssuanceRuleStatus'
updatedAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential issuance rule was last updated; can be null.
required:
- automation
- status
CredentialIssuanceRuleStagedChange:
type: object
properties:
issue:
type: array
description: An array that specifies one or more identifiers (UUIDs) of users whose credentials are in an issue action state and should be issued.
items:
type: string
revoke:
type: array
description: An array that specifies one or more identifiers (UUIDs) of users whose credentials are in an revoke action state and should be issued.
items:
type: string
stagedChanges:
type: object
properties:
action:
$ref: '#/components/schemas/EnumCredentialIssuanceRuleAutomationMethod'
createdAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the change was staged by the service.
credentialType:
type: object
properties:
id:
type: string
readOnly: true
description: A string that specifies the identifier (UUID) of the credential type with which this credential issuance rule is associated.
environment:
$ref: '#/components/schemas/ObjectEnvironment'
issuanceRule:
type: object
properties:
id:
type: string
readOnly: true
description: A string that specifies the identifier (UUID) of the credential issuance rule.
scheduled:
type: boolean
description: A boolean that specifies whether or not the staged change is scheduled.
user:
type: object
properties:
id:
type: string
description: A string that specifies the identifier (UUID) of the user identified by the filter on the credential issuance rule.
required:
- id
update:
type: array
description: An array that specifies one or more identifiers (UUIDs) of users whose credentials are in an update action state and should be issued.
items:
type: string
CredentialIssuanceRuleUsageCounts:
type: object
properties:
issued:
type: integer
readOnly: true
accepted:
type: integer
readOnly: true
updated:
type: integer
readOnly: true
revoked:
type: integer
readOnly: true
CredentialIssuanceRuleUsage:
type: array
items:
type: object
properties:
user:
type: object
properties:
id:
type: string
readOnly: true
description: A string representing the identifier (UUID) of the user identified by the filter on the credential issuance rule.
required:
- id
credential:
type: object
properties:
id:
type: string
readOnly: true
description: A string representing the identifier (UUID) of the credential subject to the issue action identified by the credential issuance rule.
required:
- id
createdAt:
type: string
format: date-time
readOnly: true
description: A string representing the date and time the credential was issued by the service.
CredentialIssuanceRuleUsageDetails:
type: object
properties:
issued:
$ref: '#/components/schemas/CredentialIssuanceRuleUsage'
revoked:
$ref: '#/components/schemas/CredentialIssuanceRuleUsage'
updated:
$ref: '#/components/schemas/CredentialIssuanceRuleUsage'
DigitalWalletApplication:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
application:
$ref: '#/components/schemas/ObjectApplication'
appOpenUrl:
type: string
description: A string that specifies the URL sent in notifications to the user to communicate with the service.
createdAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential digital wallet app was created.
environment:
$ref: '#/components/schemas/ObjectEnvironment'
id:
type: string
description: A string that specifies the identifier (UUID) associated with the credential digital wallet app.
readOnly: true
name:
type: string
description: A string that specifies the name associated with the digital wallet app.
updatedAt:
type: string
format: date-time
readOnly: true
usesPingOneWalletSDK:
type: boolean
description: A boolean that specifies whether the user's wallet app uses the PingOne Wallet SDK.
required:
- name
- appOpenUrl
- application
CredentialDigitalWallet:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
application:
type: object
properties:
id:
type: string
description: A string that specifies the ientifier (UUID) of the application running the Wallet SDK on the user’s device and registered with the service.
required:
- id
createdAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential digital wallet was created.
digitalWalletApplication:
type: object
properties:
id:
type: string
description: A string that specifies the identifier (UUID) of the customer's digital wallet app that will interact with the user's digital wallet.
required:
- id
environment:
$ref: '#/components/schemas/ObjectEnvironment'
id:
type: string
description: A string that specifies the identifier (UUID) associated with the credential digital wallet app.
notification:
type: object
properties:
methods:
type: array
items:
type: string
results:
type: array
items:
type: object
properties:
method:
type: string
sent:
type: boolean
notification:
type: object
properties:
id:
type: string
required:
- id
error:
type: object
properties:
id:
type: string
code:
type: string
message:
type: string
details:
type: array
items:
type: object
properties:
code:
type: string
message:
type: string
template:
type: object
properties:
locale:
type: string
variant:
type: string
updatedAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date and time the credential digital wallet was last updated; can be null.
user:
type: object
properties:
id:
type: string
description: A string that specifies the identifier (UUID) of the user associated with the credential digital wallet.
required:
- id
status:
type: string
description: A string that specifies the status of the wallet.
pairingSession:
type: object
properties:
id:
type: string
createdAt:
type: string
format: date-time
readOnly: true
updatedAt:
type: string
format: date-time
readOnly: true
environment:
$ref: '#/components/schemas/ObjectEnvironment'
user:
type: object
properties:
id:
type: string
required:
- id
digitalWallet:
type: object
properties:
id:
type: string
required:
- id
challenge:
type: string
qrUrl:
type: string
status:
type: string
ProvisionedCredential:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
claimReference:
type: object
properties:
id:
type: string
version:
type: integer
issuer:
type: string
subject:
type: string
holder:
type: string
createDate:
type: string
format: date-time
readOnly: true
dataJson:
type: string
dataSignature:
type: string
dataHash:
type: string
partitionId:
type: string
createdAt:
type: string
format: date-time
readOnly: true
credential:
type: object
properties:
id:
type: string
readOnly: true
digitalWallet:
type: object
properties:
id:
type: string
readOnly: true
environment:
$ref: '#/components/schemas/ObjectEnvironment'
expiredAt:
type: string
format: date-time
readOnly: true
description: A string that specifies the date that the provisioned credential expires. If this value is null, the provisioned credential never expires.
id:
type: string
readOnly: true
status:
type: string
readOnly: true
description: A string that specifies the tatus of the provisioned credential.
user:
type: object
properties:
id:
type: string
readOnly: true
description: A string that specifies the identifier (UUID) of the user associated with the provisioned credential.
walletActions:
type: array
items:
type: object
properties:
type:
type: string
readOnly: true
description: A string that specifies the action taken regarding the provisioned credential.
occurredAt:
type: string
readOnly: true
description: A string that specifies the date and time that the action occurred.
UserCredential:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
createdAt:
type: string
format: date-time
readOnly: true
credentialType:
type: object
properties:
id:
type: string
required:
- id
environment:
$ref: '#/components/schemas/ObjectEnvironment'
expiresAt:
type: string
format: date-time
readOnly: true
id:
type: string
notification:
type: object
properties:
methods:
type: array
items:
type: string
results:
type: array
items:
type: object
properties:
method:
type: string
sent:
type: boolean
notification:
type: object
properties:
id:
type: string
required:
- id
error:
type: object
properties:
id:
type: string
code:
type: string
message:
type: string
details:
type: array
items:
type: object
properties:
code:
type: string
message:
type: string
template:
type: object
properties:
locale:
type: string
variant:
type: string
status:
type: string
updatedAt:
type: string
format: date-time
readOnly: true
user:
type: object
properties:
id:
type: string
required:
- id
userdata:
type: object
properties:
CardImage:
type: string
EntityArray:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
'_embedded':
type: object
properties:
items:
type: array
items:
anyOf:
- $ref: '#/components/schemas/CredentialType'
- $ref: '#/components/schemas/UserCredential'
issuanceRules:
type: array
items:
$ref: '#/components/schemas/CredentialIssuanceRule'
stagedChanges:
type: array
items:
$ref: '#/components/schemas/CredentialIssuanceRuleStagedChange'
digitalWalletApplications:
type: array
items:
$ref: '#/components/schemas/DigitalWalletApplication'
digitalWallets:
type: array
items:
$ref: '#/components/schemas/CredentialDigitalWallet'
provisionedCredentials:
type: array
items:
$ref: '#/components/schemas/ProvisionedCredential'
size:
type: number
ObjectApplication:
type: object
readOnly: true
properties:
id:
type: string
description: A string that specifies the application resource ID associated with the object.
ObjectEnvironment:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the environment associated with the object.
ObjectIssuer:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the identifier (UUID) of the credential issuer.
ObjectOrganization:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the organization associated with the object.
ObjectPopulation:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the population 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
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: Credential Issuers
- name: Credential Types
- name: Credential Issuance Rules
- name: Digital Wallet Apps
- name: Digital Wallets
- name: User Credentials
paths:
/environments/{environmentID}/credentialIssuerProfile:
post:
tags:
- Credential Issuers
summary: Create Credential Issuer Profile
operationId: createCredentialIssuerProfile
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialIssuerProfile'
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses: