-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
1420 lines (1408 loc) · 44.1 KB
/
openapi.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.0.1
info:
title: Adatree ADR Platform Consent API
description: >-
Consent Dashboard REST APIs. This allows ADR / consumers to perform CDR
consumer authorization flow with Data Holders
version: 1.3.0
contact:
name: Adatree
email: engineering@adatree.com.au
x-konfig-ignore:
potential-incorrect-type: true
servers:
- description: Server url
url: https://cdr-insights-prod.api.adatree.com.au
tags:
- name: Consent
- name: Consent Authorization
- name: Get consent events
- name: Data Holders
- name: Tokens
- name: UseCase
paths:
/consents:
get:
tags:
- Consent
summary: Get Consents
operationId: Consent_getAllRecords
security:
- bearerAuth:
- consumer:consents:read
- consents:read
- m2m:
- consents:read
description: Get all consent records for this consumer
parameters:
- description: >
consumeId, please be kindly reminded of proper encoding as Id from
some IDP could have special character like '|', which need be
encoded as '%7c'. <br/>
consumerId should only be used with machine token, otherwise it will
be deemed BAD_REQUEST
name: consumerId
in: query
example: auth0%7c5fbc585628421a006e83d95d
required: false
schema:
type: string
- $ref: '#/components/parameters/ParamConsentId'
- $ref: '#/components/parameters/ParamCdrArrangementId'
- name: status
in: query
required: false
example: ACTIVE
schema:
type: string
enum:
- REQUESTED
- ACTIVE
- REVOKED
- EXPIRED
- name: accessFrequency
in: query
required: false
example: ONCE_OFF
schema:
type: string
enum:
- ONCE_OFF
- ONGOING
- name: postUsageAction
in: query
required: false
example: DELETION
schema:
type: string
enum:
- DELETION
- DE_IDENTIFICATION
- name: directMarketingAllowed
in: query
required: false
example: false
schema:
type: boolean
- description: UseCase ids
name: useCases
in: query
required: false
schema:
type: array
items:
type: string
- name: dataHolderBrandId
in: query
required: false
example: 55b3299a-3e50-48a2-a190-cca263ccaba5
schema:
type: string
- description: >-
Constrain the consent with created time at or after this date/time.
If absent defaults to newestCreated minus 90 days. Format is
aligned to DateTimeString common type
name: oldestCreated
in: query
required: false
schema:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
- description: >-
Constrain the consent with created time at or before this date/time.
If absent defaults to today. Format is aligned to DateTimeString
common type
name: newestCreated
in: query
required: false
schema:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
- description: >-
Constrain the consent with revoked time at or after this date/time.
If absent defaults to newestRevoked minus 90 days. Format is
aligned to DateTimeString common type
name: oldestRevoked
in: query
required: false
schema:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
- description: >-
Constrain the consent with revoked time at or before this date/time.
If absent defaults to today. Format is aligned to DateTimeString
common type
name: newestRevoked
in: query
required: false
schema:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
- description: >-
Constrain the consent with sharingEndDate time at or after this
date/time. If absent defaults to newestSharingEndDate minus 90
days. Format is aligned to DateTimeString common type
name: oldestSharingEndDate
in: query
required: false
schema:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
- description: >-
Constrain the consent with sharingEndDate time at or before this
date/time. If absent defaults to today. Format is aligned to
DateTimeString common type
name: newestSharingEndDate
in: query
required: false
schema:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
- description: Constrain the consent by externalId
name: externalId
in: query
required: false
schema:
type: string
example: an-external-id
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentGetAllRecordsResponse'
'401':
$ref: '#/components/responses/401Unauthorised'
'403':
$ref: '#/components/responses/403Forbidden'
'429':
$ref: '#/components/responses/429RateLimited'
post:
tags:
- Consent
summary: Create Consent
operationId: Consent_recordCreate
security:
- bearerAuth:
- consumer:consents:write
- consents:write
- m2m:
- consents:write
description: Create a consent record for consumer
parameters:
- $ref: '#/components/parameters/HeaderConsumerUserAgent'
- $ref: '#/components/parameters/HeaderConsumerIpAddress'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConsent'
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentResponse'
'401':
$ref: '#/components/responses/401Unauthorised'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
description: active consent exists for requested use case
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentResponse'
'429':
$ref: '#/components/responses/429RateLimited'
/consents/{consentId}:
get:
tags:
- Consent
summary: Get Consent
operationId: Consent_getRecord
security:
- bearerAuth:
- consumer:consents:read
- consents:read
- m2m:
- consents:read
description: Retreive a single consent record for this consumer
parameters:
- name: consentId
in: path
required: true
example: 148c9187-e52b-431f-9b24-7225e75ca2be
schema:
type: string
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentResponse'
'401':
$ref: '#/components/responses/401Unauthorised'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429RateLimited'
patch:
tags:
- Consent
summary: Update a consent's via dashboard or back channel
operationId: Consent_updateViaDashboard
security:
- bearerAuth:
- consumer:consents:write
- consents:write
- m2m:
- consents:write
description: >
<ul><li>Update postUsageAction, directMarketing option or sharing end
date when a dashboard token is received</li><br/>
<li>Update externalId when a machine (backchannel) token is
received</li></ul>
parameters:
- name: consentId
in: path
example: 148c9187-e52b-431f-9b24-7225e75ca2be
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentUpdateViaDashboardRequest'
responses:
'200':
description: consent successfully updated
'401':
$ref: '#/components/responses/401Unauthorised'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429RateLimited'
delete:
tags:
- Consent
summary: Revoke Consent
operationId: Consent_revokeRecord
security:
- bearerAuth:
- consumer:consents:write
- consents:write
- m2m:
- consents:write
description: Revoke a single consent record for this consumer
parameters:
- name: consentId
in: path
example: 148c9187-e52b-431f-9b24-7225e75ca2be
required: true
schema:
type: string
responses:
'200':
description: default response
'401':
$ref: '#/components/responses/401Unauthorised'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'429':
$ref: '#/components/responses/429RateLimited'
/consents/{consentId}/authorization:
get:
tags:
- Consent Authorization
summary: Get Authorization Redirect URL for a Consent
operationId: ConsentAuthorization_redirectUrl
security:
- bearerAuth:
- consumer:consents:read
- consents:read
- m2m:
- consents:read
description: >-
Get the authorization redirect URL to send the consumer to the data
holder
parameters:
- name: consentId
in: path
required: true
example: 148c9187-e52b-431f-9b24-7225e75ca2be
schema:
type: string
- description: >-
A state is generated by the consent user-agent (browser) and is used
to bind the redirection response from a Data Holder with a user
session as per
https://openid.net/specs/openid-financial-api-part-1-1_0-final.html#public-client.
It is sent in the authentication request, and is then also included
redirect from the ADH to the ADR. This allows the ADR client
application prevent CSRF attacks. Must be unique per authorization
request.
name: state
in: query
required: false
schema:
type: string
- description: >-
The URI to redirect to from the data holder when the consumer has
finished data holder authentication. Must be from the list of
redirect URIs configured at the ACCC register.
name: redirectUri
in: query
required: false
schema:
type: string
responses:
'200':
description: authorization link
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentAuthorization'
'401':
$ref: '#/components/responses/401Unauthorised'
'403':
$ref: '#/components/responses/403Forbidden'
'404':
$ref: '#/components/responses/404NotFound'
'409':
$ref: '#/components/responses/409Conflict'
'429':
$ref: '#/components/responses/429RateLimited'
/consents/events:
get:
tags:
- Get consent events
summary: Retrieve consent events
operationId: GetConsentEvents_list
security:
- bearerAuth:
- consumer:consents:read
- consents:read
- m2m:
- consents:read
parameters:
- description: >-
Constrain the consent event result list with timestamp at or after
this date/time. Format is aligned to DateTimeString common type
name: oldest
in: query
required: false
schema:
type: string
format: date-time
example: '2022-02-06T08:17:26Z'
- description: >-
Constrain the consent event result list with timestamp at or before
this date/time. Format is aligned to DateTimeString common type
name: newest
in: query
required: false
schema:
type: string
format: date-time
example: '2022-02-01T15:43:00.121Z'
- $ref: '#/components/parameters/ParamConsentId'
- $ref: '#/components/parameters/ParamPage'
- $ref: '#/components/parameters/ParamPageSize'
responses:
'200':
description: list of ConsentEvent with pagination
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentEventList'
'400':
$ref: '#/components/responses/400BadRequest'
'401':
$ref: '#/components/responses/401Unauthorised'
'403':
$ref: '#/components/responses/403Forbidden'
'429':
$ref: '#/components/responses/429RateLimited'
callbacks:
ConsentUpdated:
$YourWebhookUrl:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConsentEvent'
responses:
'200':
description: Your server returns this code if it accepts the callback
/software-products/{softwareProductId}/data-holders:
get:
tags:
- Data Holders
summary: Get Data Holders
operationId: DataHolders_listAvailable
security:
- bearerAuth:
- consumer:data-holders:read
- data-holders:read
- m2m:
- data-holders:read
description: Get the list of available data holders for a software product
parameters:
- description: >
The identifier of the software product registered at the ACCC
registry. <br/>
The list of data holders returned is the list where dynamic client
reigstration has been peformed at each data holder for this software
product. <br/>
The list of data holders for a use case can be restricted by
management API at Use Case or Software Product level
name: softwareProductId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DataHoldersListAvailableResponse'
/tokens:
post:
tags:
- Tokens
summary: Create Tokens
operationId: Tokens_establishDataAccess
security:
- bearerAuth:
- consumer:tokens:write
- consumer_tokens_write
- tokens:write
- tokens_write
- m2m:
- tokens:write
description: >-
Send the required parameters from the data holder to the ADR Platform
backend to finish extablishing data access
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Authorization'
responses:
'200':
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/TokenCreatedResponse'
/use-cases:
get:
tags:
- UseCase
summary: Get Use-cases
operationId: UseCase_getAll
security:
- bearerAuth:
- consumer:use-cases:read
- use-cases:read
- m2m:
- use-cases:read
description: >-
Get all use-cases that have been configured. A use case is your reason
for requesting consent from a consumer e.g. a home loan assessment, a
budgeting app.
parameters:
- description: >-
Combine scopes that can be combined according to the CDR Consumer
Experience Standards
name: combineScopes
in: query
required: false
example: true
schema:
type: boolean
responses:
'200':
description: successful response
content:
application/json:
schema:
$ref: '#/components/schemas/UseCaseGetAllResponse'
'401':
$ref: '#/components/responses/401Unauthorised'
'403':
$ref: '#/components/responses/403Forbidden'
'429':
$ref: '#/components/responses/429RateLimited'
components:
parameters:
ParamPage:
description: Page of results to request (standard pagination)
name: page
in: query
schema:
type: integer
format: int32
default: 1
minimum: 1
example: 1
ParamPageSize:
description: Page size to request. Default is 25 (standard pagination)
name: page-size
in: query
schema:
type: integer
default: 25
minimum: 1
example: 25
ParamConsentId:
description: consent id
name: consentId
in: query
required: false
schema:
type: string
example: 148c9187-e52b-431f-9b24-7225e75ca2be
ParamCdrArrangementId:
description: cdr arrangement id
name: cdrArrangementId
in: query
required: false
schema:
type: string
example: 45db4977-b12f-42bf-808d-2680eb4bd366
HeaderConsumerUserAgent:
description: >-
Mandatory for calls using a Machine token. The consumer's original User
Agent header
name: Adatree-Consumer-User-Agent
in: header
schema:
type: string
example: >-
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
(KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36
HeaderConsumerIpAddress:
description: >-
Mandatory for calls using a Machine token. The consumer's original IP
address.
name: Adatree-Consumer-Ip-Address
in: header
schema:
type: string
example: 127.0.0.1
responses:
401Unauthorised:
description: Unauthorised
403Forbidden:
description: Forbidden
404NotFound:
description: The specified resource was not found.
400BadRequest:
description: Request is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
409Conflict:
description: Request cannot be processed
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseErrorList'
429RateLimited:
description: Ratelimit reached
GenericError:
description: An error occurred.
content:
application/json:
schema:
type: string
example: something went wrong
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
m2m:
description: Machine to machine OAuth2 to access infosec token service
type: oauth2
flows:
clientCredentials:
tokenUrl: >-
https://adatree-nonprod-adr.auth.ap-southeast-2.amazoncognito.com/oauth2/token
scopes:
authorizations:write: allow ADR to create a Authorisation Request for a consumer
tokens:write: allow ADR to create or update Authorisation Request
schemas:
Authorization:
type: object
properties:
code:
description: >-
Authorization code returned from the data holder that will be used
as part of token request validation.
type: string
example: lFDNAS-JVITGzvba3yXfrPR8hWZlCKy6nutbzrmXKop56"
state:
description: >-
The state is a parameter returned by the data holder that is used to
prevent CSRF attacks. Must be unique per authorization request.
type: string
example: f99953a5-49a5-497c-91b6-4bd14cdace74
id_token:
description: >-
ID Token value associated with the authenticated session that is
returned from the data holder.
type: string
example: eyJraWQiOiIxZTlnZGs3IiwiYWxnIjoiUl...
response:
description: >-
response payload from the Dataholder after a successful consent
using Auth Code Flow
type: string
example: eyJraWQiOiIxZTlnZGs3IiwiYWxnIjoiUl...
TokenCreatedResponse:
type: object
properties:
activeConsentId:
description: >-
Identifier of the consent which has now been activated by the
completion of the Authorization flow.
type: string
state:
description: >-
The state generated by the consent user-agent (browser) and used to
bind the redirection response from a Data Holder with a user session
as per
https://openid.net/specs/openid-financial-api-part-1-1_0-final.html#public-client.
type: string
UseCaseDataHolder:
required:
- dataHolderBrandId
- brandName
- logoUri
type: object
properties:
dataHolderBrandId:
description: >-
The identifier of the data holder you wish the consumer to
authenticate with.
type: string
example: 7ff47a14-28bd-4b04-b216-67b367713a38
brandName:
description: >-
The brand name of the data holder you wish the consumer to
authenticate with.
type: string
example: Westpac
logoUri:
description: >-
The logo URI of the data holder you wish the consumer to
authenticate with.
type: string
example: https://www.westpac.com.au/logo
ConsentUseCaseResponse:
type: object
properties:
description:
type: string
example: Data will be used to assess your eligibility for a home loan.
id:
type: string
example: HOME_LOAN
name:
type: string
example: Home Loan Assessment
notificationType:
$ref: '#/components/schemas/NotificationType'
scopes:
type: array
items:
$ref: '#/components/schemas/ConsentScopeResponse'
consumerType:
$ref: '#/components/schemas/ConsumerType'
industries:
description: list of industries this use-case applies to.
type: array
items:
$ref: '#/components/schemas/Industry'
accessFrequency:
$ref: '#/components/schemas/AccessFrequency'
customDataSchema:
description: Stringified JSON Schema for customData
type: string
example:
\"$schema\":\"https://json-schema.org/draft/2019-09/schema\": null
\"type\":\"object\": null
\"title\":\"custom data Schema\": null
\"description\":\"JSON schema of customer data\": null
\"purpose\":\"explain why custom data is needed\": null
\"properties\":
\"employerName\":
\"type\":\"string\": null
\"displayText\":\"Employer name\": null
\"uiComponent\":
\"inputType\":\"text\": null
\"rules\":
\"required\":\"Employer name is required\": null
DataHolder:
required:
- brandName
- dataHolderBrandId
- logoUri
type: object
properties:
dataHolderBrandId:
description: >-
The ideintifier of the data holder you wish the consumer to
authenitcate with.
type: string
example: 7ff47a14-28bd-4b04-b216-67b367713a38
brandName:
description: >-
The brand name of the data holder you wish the consumer to
authenitcate with.
type: string
example: Westpac
logoUri:
description: >-
The logo URI of the data holder you wish the consumer to
authenitcate with.
type: string
example: https://www.westpac.com.au/logo
industries:
description: list of industries this data holder belongs to.
type: array
items:
$ref: '#/components/schemas/Industry'
UpdateConsentConsumer:
type: object
properties:
postUsageAction:
$ref: '#/components/schemas/PostUsageAction'
directMarketingAllowed:
type: boolean
example: true
sharingEndDate:
description: >-
new sharing end date, will be validated against sharing duration
options defined in chosen Use Case
type: string
format: date-time
example: '2023-04-19T15:43:00.121Z'
UpdateConsentMachine:
type: object
properties:
externalId:
type: string
example: external-id-by-adatree-customer
CreateConsent:
type: object
required:
- sharingEndDate
- dataHolderBrandId
- useCaseId
properties:
consumerEmail:
description: >-
this is required if chosen Use Case uses email as notification
channel
type: string
example: consumer@example.com
sharingEndDate:
description: >-
sharing end date, will be validated against sharing duration options
defined in chosen Use Case
type: string
format: date-time
example: '2023-04-19T15:43:00.121Z'
dataHolderBrandId:
type: string
example: 55b3299a-3e50-48a2-a190-cca263ccaba5
useCaseId:
type: string
example: HOME_LOAN
postUsageAction:
$ref: '#/components/schemas/PostUsageAction'
directMarketingAllowed:
type: boolean
example: false
externalId:
description: >-
Adatree's customer can supply an externalId when creating consents
to associate with records in its own system
type: string
example: external-id-by-adatree-customer
consumerId:
description: >
consumeId, please be kindly reminded of proper encoding as Id from
some IDP could have special character like '|', which need be
encoded as '%7c'. <br/>
consumerId is required (and only accepted) for backchannel consent
creation
type: string
example: auth0%7c5fbc585628421a006e83d95d
grantee:
$ref: '#/components/schemas/Grantee'
customData:
type: object
example:
employerName: Adatree
ConsentAuthorization:
description: Authorization link for a Consent
type: object
properties:
uri:
example: >-
https://id.rab.sandbox.adatree.com.au/identity/authorization?response_type=code+id_token&client_id=abcdefg&request_uri=urn%3Aietf%3Aparams%3Aoauth%3Arequest_uri%3A-asdfasdfuhlkjshdf_akjsldflasjd&scope=openid+bank%3Aaccounts.basic%3Aread+bank%3Aaccounts.detail%3Aread+bank%3Atransactions%3Aread+common%3Acustomer.basic%3Aread
type: string
ConsentResponse:
type: object
properties:
version:
type: integer
format: int32
example: 1
created:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
revoked:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
lastNotificationSentAt:
type: string
format: date-time
example: '1997-01-12T15:43:00.121Z'
firstDataCollection:
type: string
format: date-time
example: '2012-01-12T15:43:00.121Z'
status:
$ref: '#/components/schemas/Status'
sharingEndDate:
type: string
format: date-time
example: '2023-04-19T15:43:00.121Z'
consumerEmail:
type: string
example: consumer@example.com
dataHolderName:
type: string
example: ANZ
dataHolderBrandId:
type: string
example: f632041c-d7c8-4679-a165-aa406cd62b13
dataHolderLogoUri:
type: string
example: https://www.abank.com.au/logo
useCase:
$ref: '#/components/schemas/ConsentUseCaseResponse'
postUsageAction:
$ref: '#/components/schemas/PostUsageAction'
consumerId:
type: string
example: abedfaas-asdfsf-4asdf-1465-sfsadf3413
cdrArrangementId:
type: string
example: 86a5d068-447a-4765-95c2-6f5d85d9d658
consentId:
type: string
example: 7c7853a6-5466-11eb-ae93-0242ac130002
directMarketingAllowed:
type: boolean
example: false
externalId:
description: >-
Adatree's customer can supply an externalId when creating consents
to associate with records in its own system
type: string
example: external-id-by-adatree-customer
grantee:
$ref: '#/components/schemas/ConsentGrantee'
serviceProvider:
$ref: '#/components/schemas/ServiceProvider'
customData:
type: object
example:
employerName: Adatree
ConsentScopeResponse:
type: object
properties:
name:
type: string
example: Bank account name, type and balance
id:
type: string
example: bank:accounts.basic:read
purpose:
type: string
example: This will allow us to provide the best service of all kinds
priority:
type: integer
example: 1
format: int32
ScopeResponse:
type: object
properties:
description:
type: string
example: This will allow us to access basic information about your accounts
name:
type: string
example: Bank account name, type and balance
id:
type: string
example: bank:accounts.basic:read
purpose:
type: string
example: This will allow us to provide best of kind service
claims:
type: array
example:
- Name of account
- Type of account
- Account balance
items:
type: string
priority:
type: integer
example: 1
format: int32
ConsentEventData:
properties: