-
Notifications
You must be signed in to change notification settings - Fork 13
/
Identity-Provider.yaml
1641 lines (1595 loc) · 65.7 KB
/
Identity-Provider.yaml
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
x-stoplight:
id: 6f1syzijynu40
info:
title: ID Building Block
version: '1.0'
contact:
name: MOSIP Team
email: info@mosip.io
url: 'https://www.mosip.io/'
description: |-
This API document details on the below categories of endpoints
<ul>
<li> Client Management - Endpoints for creation and updation of OIDC client details </li>
<li> OIDC - All OIDC compliant endpoints for performing the Open ID Connect flows</li>
<li> Wallet - QR Code - All endpoints used by the Wallet binding and Wallet - QR code based authentication</li>
</ul>
<b>Abbreviations:</b></br></br>
OIDC - Open ID Connect</br>
IdP - Identity provider</br>
KYC - Know Your Customer</br>
UIN - Unique Identification Number</br>
VID - Virtual Identifier</br>
PSUT - Partner(Relying Party) Specific User Token</br>
license:
name: MPL-2.0
url: 'https://www.mozilla.org/en-US/MPL/2.0/'
summary: Open ID Connect based identity verifier for large scale authentications
servers: []
paths:
/client-mgmt/oidc-client:
post:
summary: Create OIDC Client Endpoint
operationId: post-client
requestBody:
content:
application/json:
schema:
type: object
description: OIDC client details
properties:
requestTime:
type: string
pattern: ''
description: Current date and time when the request is sent
request:
type: object
required:
- clientId
- clientName
- relyingPartyId
- logoUri
- redirectUris
- authContextRefs
- publicKey
- userClaims
- grantTypes
- clientAuthMethods
properties:
clientId:
type: string
description: 'Unique OIDC client id (Case-Sensitive). If duplicates found, request will be rejected.'
example: 785b806d0e594657b05aabdb30fff8a4
maxLength: 50
minLength: 1
clientName:
type: string
minLength: 1
maxLength: 256
description: Name of OIDC client.
example: ABC Health Care
relyingPartyId:
type: string
description: |-
Relying Party ID of the client. This will be passed on to authentications servers when KYC is fetched.
Note: Use the client Id as relyingPartyId if there is no separate concept of relying party in the ID authentication system.
example: bharathi-inc
minLength: 1
maxLength: 50
logoUri:
type: string
description: Relying party logo URI which will used to display logo in OIDC login and permission pages.
format: uri
minLength: 1
maxLength: 1024
redirectUris:
type: array
description: |-
Valid list of callback Uris of the relying party.
When OIDC authorize API is called, any one Uri from this list should be sent as redirect_uri. authorization_code will be redirected to this Uri on successful authentication.
minItems: 1
uniqueItems: true
items:
type: string
minLength: 1
format: uri
authContextRefs:
type: array
description: The Authentication Context Class Reference is case-sensitive string specifying a list of Authentication Context Class values that identifies the Authentication Context Class. Values that the authentication performed satisfied implying a Level Of Assurance.
minItems: 1
items:
type: string
enum:
- 'idbb:acr:static-code'
- 'idbb:acr:generated-code'
- 'idbb:acr:linked-wallet'
- 'idbb:acr:biometrics'
- 'idbb:acr:biometrics-generated-code'
- 'idbb:acr:linked-wallet-static-code'
publicKey:
type: object
description: |-
OIDC client's public key used to verify the client's private_key_jwt when OIDC token endpoint is invoked.
This field will not be allowed to udpate later, if the private key is compromised, then new OIDC client to be created.
Format : Json Web Key (JWK).
userClaims:
type: array
description: 'Allowed user info claims, that can be requested by OIDC client in the authorize API'
minItems: 1
items:
type: string
enum:
- name
- given_name
- family_name
- middle_name
- preferred_username
- nickname
- gender
- birthdate
- email
- email_verified
- phone_number
- phone_number_verified
- picture
- address
- locale
- zoneinfo
grantTypes:
type: array
description: Form of Authorization Grant presented to token endpoint
minItems: 1
uniqueItems: true
items:
type: string
enum:
- authorization_code
clientAuthMethods:
type: array
description: Auth method supported for token endpoint. At present only "private_key_jwt" is supported.
minItems: 1
items:
type: string
enum:
- private_key_jwt
required:
- requestTime
- request
examples:
example-1:
value:
requestTime: '2011-10-05T14:48:00.000Z'
request:
clientId: e-health-service
clientName: Health Service
relyingPartyId: bharath-gov
logoUri: 'http://example.com'
redirectUris:
- 'http://example.com/login-success'
publicKey: {}
authContextRefs:
- 'idbb:acr:generated-code'
userClaims:
- name
grantTypes:
- authorization_code
clientAuthMethods:
- private_key_jwt
description: ''
description: |-
API to add new open ID connect (OIDC) clients, it can be invoked by other modules which manages the relying parties / partners.
Each relying party can associate to one or multiple OIDC client Ids.
On create, OIDC client status will be by default set to "**active**".
x-internal: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
responseTime:
type: string
description: Date and time when the response is generated
response:
type: object
properties:
clientId:
type: string
description: Client id as provided in the request.
errors:
type: array
items:
type: object
additionalProperties: false
properties:
errorCode:
type: string
enum:
- duplicate_client_id
- invalid_public_key
- invalid_input
- invalid_client_id
- invalid_client_name
- invalid_rp_id
- invalid_claim
- invalid_acr
- invalid_uri
- invalid_redirect_uri
- invalid_grant_type
- invalid_client_auth
- invalid_request
errorMessage:
type: string
'401':
description: Unauthorized
tags:
- Client Management
parameters: []
security:
- Authorization-add_oidc_client: []
parameters: []
'/client-mgmt/oidc-client/{client_id}':
parameters:
- schema:
type: string
example: 785b806d0e594657b05aabdb30fff8a4
name: client_id
in: path
required: true
description: Client Identifier
put:
summary: Update OIDC Client Endpoint
operationId: put-oidc-client-client_id
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
responseTime:
type: string
description: Date and time when the response is generated
response:
type: object
properties:
clientId:
type: string
description: OIDC client identifier.
required:
- clientId
errors:
type: array
description: 'List of Errors in case of request validation / processing failure in IDBB server. When request processing is fully successful, this array will be empty.'
items:
type: object
properties:
errorCode:
type: string
enum:
- invalid_client_id
- invalid_client_name
- invalid_claim
- invalid_acr
- invalid_uri
- invalid_redirect_uri
- invalid_grant_type
- invalid_client_auth
- invalid_request
errorMessage:
type: string
description: |-
API to update existing Open ID Connect (OIDC) client, it can be invoked by other modules which manages the relying parties / partners when there any updates on the fields accepted in this API.
**Authentication and authorization** is based on a valid JWT issued by a trusted IAM system including "**update_oidc_client**" scope.
requestBody:
content:
application/json:
schema:
type: object
properties:
requestTime:
type: string
pattern: ''
description: Current date and time when the request is sent
request:
type: object
required:
- clientName
- status
- logoUri
- redirectUris
- userClaims
- authContextRefs
- grantTypes
- clientAuthMethods
properties:
clientName:
type: string
description: Name of the OIDC client.
minLength: 1
maxLength: 256
example: ABC Health Care
status:
type: string
enum:
- active
- inactive
description: Status of OIDC client.
logoUri:
type: string
description: Relying party logo URI which will used to display logo in OIDC login and permissi
format: uri
minLength: 1
maxLength: 1024
redirectUris:
type: array
description: 'Valid list of callback Uris of the relying party. When OIDC authorize API is called, any one Uri from this list should be sent as redirect_uri. authorization_code will be redirected to this Uri on successful authentication.'
minItems: 1
uniqueItems: true
items:
type: string
format: uri
minLength: 1
userClaims:
type: array
description: 'Allowed user info claims, that can be requested by OIDC client in the authorize API'
minItems: 1
items:
type: string
enum:
- name
- given_name
- family_name
- middle_name
- preferred_username
- nickname
- gender
- birthdate
- email
- email_verified
- phone_number
- phone_number_verified
- picture
- address
- locale
- zoneinfo
authContextRefs:
type: array
description: The Authentication Context Class Reference is case-sensitive string specifying a list of Authentication Context Class values that identifies the Authentication Context Class. Values that the authentication performed satisfied implying a Level Of Assurance.
minItems: 1
uniqueItems: true
items:
type: string
enum:
- 'idbb:acr:static-code'
- 'idbb:acr:generated-code'
- 'idbb:acr:linked-wallet'
- 'idbb:acr:biometrics'
- 'idbb:acr:biometrics-generated-code'
- 'idbb:acr:linked-wallet-static-code'
grantTypes:
type: array
description: Form of Authorization Grant presented to token endpoint.
minItems: 1
items:
type: string
enum:
- authorization_code
clientAuthMethods:
type: array
description: Auth method supported for token endpoint. At present only "private_key_jwt" is supported.
minItems: 1
items:
type: string
enum:
- private_key_jwt
required:
- requestTime
- request
examples:
example-1:
value:
requestTime: '2022-09-22T08:03:45.000Z'
request:
clientName: Health Service
status: active
logoUri: 'http://example.com'
redirectUris:
- 'http://example.com/login-success'
userClaims:
- name
authContextRefs:
- 'idbb:acr:generated-code'
grantTypes:
- authorization_code
clientAuthMethods:
- private_key_jwt
description: ''
security:
- Authorization-update_oidc_client: []
tags:
- Client Management
/authorize:
get:
summary: Authorization Endpoint
operationId: get-authorize
description: |-
This is the authorize endpoint of Open ID Connect (OIDC). The relying party applications will do a browser redirect to this endpoint with all required details passed as query parameters.
This endpoint will respond with a HTML page / JS application to be loaded in the browser.
All the validations on the query parameter values will be performed, in case of any failures respective error message will be sent along with browser redirection back to relying party application.
parameters:
- schema:
type: string
default: openid profile
enum:
- openid profile
- openid
- profile
- email
- address
- phone
- offline_access
in: query
name: scope
description: Specifies what access privileges are being requested for Access Tokens. The scopes associated with Access Tokens determine what resources will be available when they are used to access OAuth 2.0 protected endpoints. OpenID Connect requests MUST contain the OpenID scope value.
required: true
- schema:
type: string
enum:
- code
in: query
name: response_type
description: 'The value set here determines the authorization processing flow. To use the Authorization Code Flow, the value should be configured to "code".'
required: true
- schema:
type: string
maxLength: 256
in: query
name: client_id
required: true
description: Valid OAuth 2.0 Client Identifier in the Authorization Server.
- schema:
type: string
format: uri
in: query
name: redirect_uri
description: Redirection URI to which the response would be sent. This URI must match one of the redirection URI values during the client ID creation.
required: true
- schema:
type: string
maxLength: 256
in: query
description: 'Opaque value used to maintain state between the request and the callback. Typically, Cross-Site Request Forgery (CSRF, XSRF) mitigation is done by cryptographically binding the value of this parameter with a browser cookie.'
name: state
- schema:
type: string
in: query
description: 'String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified from the Authentication Request to the ID Token.'
name: nonce
- schema:
type: string
enum:
- page
- popup
- touch
- wap
in: query
name: display
description: ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the end user.
- schema:
type: string
enum:
- none
- login
- consent
- select_account
example: consent
in: query
name: prompt
description: Space delimited case-sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for re-authentication and consent.
- schema:
type: number
in: query
name: max_age
description: 'Maximum Authentication Age. This specifies the allowable elapsed time in seconds since the last time the end user was actively authenticated by the OP. If the elapsed time is greater than this value, then the OP MUST attempt to actively re-authenticate the end user. The max_age request parameter corresponds to the OpenID 2.0 PAPE [OpenID.PAPE] max_auth_age request parameter. When max_age is used, the ID Token returned MUST include an auth_time claim value.'
- schema:
type: string
in: query
name: ui_locales
description: 'End user''s preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value "fr-CA fr en" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.'
- schema:
type: string
enum:
- 'idbb:acr:static-code'
- 'idbb:acr:generated-code'
- 'idbb:acr:linked-wallet'
- 'idbb:acr:biometrics'
- 'idbb:acr:biometrics-generated-code'
- 'idbb:acr:linked-wallet-static-code'
in: query
name: acr_values
description: 'Requested Authentication Context Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication Context Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter.'
- schema:
type: string
in: query
name: claims_locales
description: 'End-User''s preferred languages and scripts for Claims being returned, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.'
- schema:
type: string
in: query
name: claims
description: This parameter is used to request specific claims to be returned. The value is a JSON object listing the requested claims. The claims parameter value is represented in an OAuth 2.0 request as UTF-8 encoded JSON.
responses:
'200':
description: |-
OK
Loads IDBB UI application in browser for interacting with user for Login process
tags:
- OIDC
parameters: []
/linked-authorization/link-code:
post:
summary: Generate Link Code endpoint
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
responseTime:
type: string
response:
type: object
properties:
transactionId:
type: string
description: The same transactionId passed as part of the request.
linkCode:
type: string
description: Unique random string mapped to this transactionId.
expireDateTime:
type: string
description: Expire date time (ISO format) for the generated linkCode. After this date time linkCode in this request is not valid.
errors:
type: array
items:
type: object
properties:
errorCode:
type: string
enum:
- invalid_transaction_id
- link_code_gen_failed
- invalid_transaction
- invalid_request
errorMessage:
type: string
operationId: get-authorization-generate-link-code
description: |-
Generate link code request is raised from IDBB UI application.
1. UI application creates a deeplink with this link-code as parameter.
2. This deeplink is embedded in a Machine-readable-code (like QR code) and the same is rendered in the UI.
3. End user scans this machine-readable-code to open wallet app.
4. On open of wallet-app, wallet-app invokes /link-transaction endpoint.
5. In the UI application, once machine-readable-code is rendered, at the same time /link-status endpoint is invoked as a long polling request.
requestBody:
content:
application/json:
schema:
type: object
properties:
requestTime:
type: string
request:
type: object
required:
- transactionId
properties:
transactionId:
type: string
description: TransactionId that associates the current transaction / session with the relying party redirection. IDBB backend application should be able to maintain this association with respective to the transaction Id.
required:
- requestTime
- request
parameters:
- schema:
type: string
in: header
name: X-XSRF-TOKEN
description: CSRF token as set in cookie key 'XSRF-TOKEN'
required: true
tags:
- Wallet - QR Code
parameters: []
/linked-authorization/link-status:
post:
summary: Link status endpoint
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
responseTIme:
type: string
response:
type: object
properties:
transactionId:
type: string
description: This is the same transactionId as sent in the request.
linkStatus:
type: string
description: Link status of the linkCode passed in the request.
enum:
- LINKED
linkedDateTime:
type: string
description: Epoch in milliseconds at which the wallet-app acknowledged the link-code.
errors:
type: array
items:
type: object
properties:
errorCode:
type: string
enum:
- invalid_transaction_id
- invalid_link_code
- response_timeout
- unknown_error
- invalid_request
errorMessage:
type: string
operationId: post-authorization-link-status
requestBody:
content:
application/json:
schema:
type: object
properties:
requestTime:
type: string
request:
type: object
required:
- transactionId
- linkCode
properties:
transactionId:
type: string
description: This is the same transactionId sent in the /link-code request
linkCode:
type: string
description: This is same linkCode returned in the generate-link-code response.
required:
- requestTime
- request
description: |-
The link status endpoint is invoked from IDBB UI application.
1. Checks the status of link code and will return the status as LINKED once the /link-transaction endpoint is called from wallet application.
parameters:
- schema:
type: string
in: header
name: X-XSRF-TOKEN
description: CSRF token as set in cookie key 'XSRF-TOKEN'
required: true
tags:
- Wallet - QR Code
parameters: []
/linked-authorization/link-auth-code:
post:
summary: Link authorization code endpoint
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
responseTime:
type: string
response:
type: object
properties:
code:
type: string
description: Authorization code. Required to obtain the ID token and / or access token from the /token endpoint.
redirectUri:
type: string
description: Client's validated redirect URI.
state:
type: string
description: 'The echoed state value, used to maintain state between the request and the callback'
nonce:
type: string
description: 'The echoed nonce value, if one was passed with the request. Clients must validate the value before proceeding.'
errors:
type:
- array
items:
type: object
properties:
errorCode:
type: string
enum:
- invalid_transaction
- invalid_transaction_id
- invalid_link_code
- response_timeout
- unknown_error
- invalid_request
errorMessage:
type: string
operationId: post-authorization-link-auth
requestBody:
content:
application/json:
schema:
type: object
properties:
requestTime:
type: string
request:
type: object
required:
- transactionId
- linkedCode
properties:
transactionId:
type: string
description: This is the same transactionId sent in the /link-code request.
linkedCode:
type: string
description: linkCode for which status is already received as LINKED.
required:
- requestTime
- request
description: |-
Link authorization code endpoint is invoked from UI application.
1. This is a Long polling request to IDBB backend.
2. validates the transactionId
3. validates the linkCode if its LINKED.
4. checks the cache to see if the auth-code is generated, if yes returns the response.
5. If the auth-code is not yet generated, polling request waits for the configured time.
6. On successful response, IDBB UI should redirect to the provided redirectUri with auth-code or error details.
parameters:
- schema:
type: string
in: header
name: X-XSRF-TOKEN
description: CSRF token as set in cookie key 'XSRF-TOKEN'
required: true
tags:
- Wallet - QR Code
parameters: []
/linked-authorization/link-transaction:
post:
summary: Link Transaction endpoint
operationId: post-authorization-link-transaction
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
responseTime:
type: string
response:
type: object
properties:
linkTransactionId:
type: string
description: Unique link-transaction-id.
clientName:
type: string
description: Registered name of the OIDC client.
logoUrl:
type: string
description: Registered OIDC client Logo URL.
authorizeScopes:
type: array
description: List of requested scopes to be permitted by the end user.
items:
type: string
essentialClaims:
type: array
description: List of client request mandatory claim names.
items:
type: string
voluntaryClaims:
type: array
description: List of client request optional claim names.
items:
type: string
authFactors:
type: array
description: Auth factors defines the authentication modes that can be used to veifiy the user. More than one authFactor may be resolved or combination of auth factors. Precedence of authFactors is based on its order
items:
type: array
items:
$ref: '#/components/schemas/AuthFactor'
configs:
type: object
errors:
type: array
items:
type: object
properties:
errorCode:
type: string
enum:
- invalid_link_code
- invalid_transaction
- invalid_client_id
- unknown_error
- invalid_request
errorMessage:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
requestTime:
type: string
request:
type: object
required:
- linkCode
properties:
linkCode:
type: string
description: Link code as received by the wallet-app from the QR code scanning.
required:
- requestTime
- request
description: |-
The link transaction endpoint is invoked from Wallet-app.
1. Validates the link-code and its expiry and generates the linkTransactionId. This linkTransactionId is linked to transactionId used in the /link-code endpoint.
2. Returns the auth-factors, clientName, logoUrl, User claims, authorize scopes along with linkTransactionId.
**Note:**
Wallet-app will hereafter address the transaction with this linkTransactionId for the /authenticate and /consent endpoints.
tags:
- Wallet - QR Code
parameters: []
/linked-authorization/authenticate:
post:
summary: Linked Authentication Endpoint
operationId: post-linked-authenticate
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
responseTime:
type: string
response:
type: object
properties:
linkedTransactionId:
type: string
description: This is the same transactionId received from /link-transaction endpoint.
errors:
type: array
description: List of Errors in case of request validation / processing failure in IDBB server.
items:
type: object
properties:
errorCode:
type: string
enum:
- invalid_transaction_id
- invalid_transaction
- invalid_identifier
- invalid_no_of_challenges
- auth_failed
- unknown_error
- invalid_request
errorMessage:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
requestTime:
type: string
pattern: 'yyyy-MM-dd''T''HH:mm:ss.SSS''Z'''
request:
type: object
required:
- linkedTransactionId
- individualId
- challengeList
properties:
linkedTransactionId:
type: string
description: This is the same transactionId received from /link-transaction endpoint
individualId:
type: string
description: User identifier (UIN/VID).
challengeList:
type: array
description: Authentication Challenge.
items:
$ref: '#/components/schemas/AuthChallenge'
required:
- requestTime
- request
description: ''
description: |-
Once end user provides the user identifier (UIN/VID) and all the required auth challenge to the Wallet-app, this endpoint will be invoked from wallet-app.
Supported auth-challenge depends on the integrated IDBB implementation.
1. Validates linkedTransactionId.
2. Validates null / empty individualId.
On Authentication Success: Only linkTransactionId is returned in the below response without any errors.
On Authentication Failure: Error list will be returned.
parameters: []
tags:
- Wallet - QR Code
parameters: []
/linked-authorization/consent:
post:
summary: Linked Consent Endpoint
operationId: post-linked-consent
description: |
Once the authentication is successful and user permission is obtained, this endpoint will be invoked by the wallet app to send the accepted user claims and permitted scopes.
1. Validates linkedTransactionId.
2. Validate accepted claims and permitted scopes in the request.
3. If valid, stores the accepted claims and permitted scopes in the datastore.
requestBody:
content:
application/json:
schema:
type: object
properties:
requestTime:
type: string
pattern: 'yyyy-MM-dd''T''HH:mm:ss.SSS''Z'''
request:
type: object
required:
- linkedTransactionId
properties:
linkedTransactionId:
type: string
description: This is the same transactionId received from /link-transaction endpoint.
permittedAuthorizeScopes:
type: array
description: List of permitted scopes by end-user.