Skip to content

Commit 6be8861

Browse files
typescript-bottypescript-bot
committed
🤖 dprint fmt
1 parent 0e0fbba commit 6be8861

File tree

8 files changed

+9841
-9904
lines changed

8 files changed

+9841
-9904
lines changed

‎types/consumer-data-standards/admin/index.d.ts‎

Lines changed: 835 additions & 835 deletions
Large diffs are not rendered by default.

‎types/consumer-data-standards/banking/index.d.ts‎

Lines changed: 3115 additions & 3108 deletions
Large diffs are not rendered by default.

‎types/consumer-data-standards/common/index.d.ts‎

Lines changed: 415 additions & 410 deletions
Large diffs are not rendered by default.

‎types/consumer-data-standards/dcr/index.d.ts‎

Lines changed: 164 additions & 164 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
/* These are the schema definitions stipulated by the Data Standards Body for the dcr api. */
22

33
export type ClientRegistration = {
4-
/**
5-
* Contains the identifier for the ADR Software Product (SoftwareProductId) as defined in the CDR Register.
6-
*/
7-
iss: string;
8-
/**
9-
* The time at which the request was issued by the Data Recipient expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC.
10-
*/
11-
iat: number;
12-
/**
13-
* The time at which the request expires expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC.
14-
*/
15-
exp: number;
16-
/**
17-
* Unique identifier for the JWT, used to prevent replay of the token.
18-
*/
19-
jti: string;
20-
/**
21-
* Contains the Data Holder issuer value as described in the OIDC Discovery Document.
22-
*/
23-
aud: string;
4+
/**
5+
* Contains the identifier for the ADR Software Product (SoftwareProductId) as defined in the CDR Register.
6+
*/
7+
iss: string;
8+
/**
9+
* The time at which the request was issued by the Data Recipient expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC.
10+
*/
11+
iat: number;
12+
/**
13+
* The time at which the request expires expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC.
14+
*/
15+
exp: number;
16+
/**
17+
* Unique identifier for the JWT, used to prevent replay of the token.
18+
*/
19+
jti: string;
20+
/**
21+
* Contains the Data Holder issuer value as described in the OIDC Discovery Document.
22+
*/
23+
aud: string;
2424
} & RegistrationProperties;
2525
/* These are the schema definitions stipulated by the Data Standards Body for the dcr api. */
2626

@@ -37,152 +37,152 @@ export type ClientRegistrationRequestV1 = string;
3737
/* These are the schema definitions stipulated by the Data Standards Body for the dcr api. */
3838

3939
export interface RegistrationError {
40-
/**
41-
* Predefined error code as described in [section 3.3 OIDC Dynamic Client Registration](https://openid.net/specs/openid-connect-registration-1_0.html).
42-
*/
43-
error:
44-
| "invalid_redirect_uri"
45-
| "invalid_client_metadata"
46-
| "invalid_software_statement"
47-
| "unapproved_software_statement";
48-
/**
49-
* Additional text description of the error for debugging.
50-
*/
51-
error_description?: string | null;
40+
/**
41+
* Predefined error code as described in [section 3.3 OIDC Dynamic Client Registration](https://openid.net/specs/openid-connect-registration-1_0.html).
42+
*/
43+
error:
44+
| "invalid_redirect_uri"
45+
| "invalid_client_metadata"
46+
| "invalid_software_statement"
47+
| "unapproved_software_statement";
48+
/**
49+
* Additional text description of the error for debugging.
50+
*/
51+
error_description?: string | null;
5252
}
5353
/* These are the schema definitions stipulated by the Data Standards Body for the dcr api. */
5454

5555
export interface RegistrationProperties {
56-
/**
57-
* Kind of the application. The only supported application type will be `web`.
58-
*/
59-
application_type?: "web" | null;
60-
/**
61-
* The JWE _alg_ algorithm required for encrypting authorization responses. If unspecified, the default is that no encryption is performed.<br><br>Required if _authorization_encrypted_response_enc_ is included.
62-
*/
63-
authorization_encrypted_response_alg?: ("RSA-OAEP" | "RSA-OAEP-256") | null;
64-
/**
65-
* The JWE _enc_ algorithm required for encrypting authorization responses. If _authorization_encrypted_response_alg_ is specified, the default for this value is `A128CBC-HS256`.
66-
*/
67-
authorization_encrypted_response_enc?: ("A256GCM" | "A128CBC-HS256") | null;
68-
/**
69-
* The JWS _alg_ algorithm required for signing authorization responses. If this is specified, the response will be signed using JWS and the configured algorithm. The algorithm `none` is not allowed.<br><br>Required if _response_type_ of `code` is registered by the client.
70-
*/
71-
authorization_signed_response_alg?: ("PS256" | "ES256") | null;
72-
/**
73-
* Human-readable string name of the software product description to be presented to the end user during authorization.
74-
*/
75-
client_description: string;
76-
/**
77-
* Data Holder issued client identifier string.
78-
*/
79-
client_id: string;
80-
/**
81-
* Time at which the client identifier was issued expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC.
82-
*/
83-
client_id_issued_at?: number | null;
84-
/**
85-
* Human-readable string name of the software product to be presented to the end-user during authorization.
86-
*/
87-
client_name: string;
88-
/**
89-
* URL string of a web page providing information about the client.
90-
*/
91-
client_uri: string;
92-
/**
93-
* Array of OAuth 2.0 grant type strings that the client can use at the token endpoint.
94-
*/
95-
grant_types: ("client_credentials" | "authorization_code" | "refresh_token")[];
96-
/**
97-
* JWE _alg_ algorithm with which an id_token is to be encrypted.<br/><br/>Required only if OIDC Hybrid Flow (_response_type_: `code id_token`) is registered.
98-
*/
99-
id_token_encrypted_response_alg?: string | null;
100-
/**
101-
* JWE `enc` algorithm with which an id_token is to be encrypted.<br/><br/>Required only if OIDC Hybrid Flow (_response_type_: `code id_token`) is registered.
102-
*/
103-
id_token_encrypted_response_enc?: string | null;
104-
/**
105-
* Algorithm with which an id_token is to be signed.
106-
*/
107-
id_token_signed_response_alg: "PS256" | "ES256";
108-
/**
109-
* URL string referencing the client JSON Web Key (JWK) Set **[[RFC7517]](#nref-RFC7517)** document, which contains the client public keys.
110-
*/
111-
jwks_uri: string;
112-
/**
113-
* A unique identifier string assigned by the CDR Register that identifies the Accredited Data Recipient Legal Entity.
114-
*/
115-
legal_entity_id?: string | null;
116-
/**
117-
* Human-readable string name of the Accredited Data Recipient Legal Entity.
118-
*/
119-
legal_entity_name?: string | null;
120-
/**
121-
* URL string that references a logo for the client. If present, the server **SHOULD** display this image to the end-user during approval.
122-
*/
123-
logo_uri: string;
124-
/**
125-
* A unique identifier string assigned by the CDR Register that identifies the Accredited Data Recipient Brand.
126-
*/
127-
org_id: string;
128-
/**
129-
* Human-readable string name of the Accredited Data Recipient to be presented to the end user during authorization.
130-
*/
131-
org_name: string;
132-
/**
133-
* URL string that points to a human-readable policy document for the Software Product.
134-
*/
135-
policy_uri?: string | null;
136-
/**
137-
* Base URI for the Consumer Data Standard Data Recipient endpoints. This should be the base to provide reference to all other Data Recipient Endpoints.
138-
*/
139-
recipient_base_uri?: string | null;
140-
/**
141-
* Array of redirection URI strings for use in redirect-based flows. If used, _redirect_uris_ **MUST** match or be a subset of the _redirect_uris_ as defined in the SSA.
142-
*/
143-
redirect_uris: string[];
144-
/**
145-
* Algorithm which the ADR expects to sign the request object if a request object will be part of the authorization request sent to the Data Holder.
146-
*/
147-
request_object_signing_alg: "PS256" | "ES256";
148-
/**
149-
* Array of the OAuth 2.0 _response_type_ strings that the client can use at the authorization endpoint.<br><br>_response_type_ value `code` is required for Authorization Code Flow.<br>_response_type_ value `code id_token` is required for OIDC Hybrid Flow.
150-
*/
151-
response_types: ("code" | "code id_token")[];
152-
/**
153-
* URI string that references the location of the Software Product consent revocation endpoint.
154-
*/
155-
revocation_uri?: string | null;
156-
/**
157-
* String containing a space-separated list of scope values that the client can use when requesting access tokens.
158-
*/
159-
scope: string;
160-
/**
161-
* URL string referencing the client sector identifier URI, used as an optional input to the Pairwise Identifier.
162-
*/
163-
sector_identifier_uri?: string | null;
164-
/**
165-
* String representing a unique identifier assigned by the Register and used by registration endpoints to identify the software product to be dynamically registered. <br><br>The _software_id_ will remain the same for the lifetime of the product, across multiple updates and versions.
166-
*/
167-
software_id: string;
168-
/**
169-
* String containing a role of the software in the CDR Regime. Initially the only value used will be `data-recipient-software-product`.
170-
*/
171-
software_roles?: "data-recipient-software-product" | null;
172-
/**
173-
* The Software Statement Assertion, as defined in the CDR Data Standards.
174-
*/
175-
software_statement: string;
176-
/**
177-
* The requested authentication method for the token endpoint.
178-
*/
179-
token_endpoint_auth_method: "private_key_jwt";
180-
/**
181-
* The algorithm used for signing the JWT.
182-
*/
183-
token_endpoint_auth_signing_alg: "PS256" | "ES256";
184-
/**
185-
* URL string that points to a human-readable terms of service document for the Software Product.
186-
*/
187-
tos_uri?: string | null;
56+
/**
57+
* Kind of the application. The only supported application type will be `web`.
58+
*/
59+
application_type?: "web" | null;
60+
/**
61+
* The JWE _alg_ algorithm required for encrypting authorization responses. If unspecified, the default is that no encryption is performed.<br><br>Required if _authorization_encrypted_response_enc_ is included.
62+
*/
63+
authorization_encrypted_response_alg?: ("RSA-OAEP" | "RSA-OAEP-256") | null;
64+
/**
65+
* The JWE _enc_ algorithm required for encrypting authorization responses. If _authorization_encrypted_response_alg_ is specified, the default for this value is `A128CBC-HS256`.
66+
*/
67+
authorization_encrypted_response_enc?: ("A256GCM" | "A128CBC-HS256") | null;
68+
/**
69+
* The JWS _alg_ algorithm required for signing authorization responses. If this is specified, the response will be signed using JWS and the configured algorithm. The algorithm `none` is not allowed.<br><br>Required if _response_type_ of `code` is registered by the client.
70+
*/
71+
authorization_signed_response_alg?: ("PS256" | "ES256") | null;
72+
/**
73+
* Human-readable string name of the software product description to be presented to the end user during authorization.
74+
*/
75+
client_description: string;
76+
/**
77+
* Data Holder issued client identifier string.
78+
*/
79+
client_id: string;
80+
/**
81+
* Time at which the client identifier was issued expressed as seconds since 1970-01-01T00:00:00Z as measured in UTC.
82+
*/
83+
client_id_issued_at?: number | null;
84+
/**
85+
* Human-readable string name of the software product to be presented to the end-user during authorization.
86+
*/
87+
client_name: string;
88+
/**
89+
* URL string of a web page providing information about the client.
90+
*/
91+
client_uri: string;
92+
/**
93+
* Array of OAuth 2.0 grant type strings that the client can use at the token endpoint.
94+
*/
95+
grant_types: ("client_credentials" | "authorization_code" | "refresh_token")[];
96+
/**
97+
* JWE _alg_ algorithm with which an id_token is to be encrypted.<br/><br/>Required only if OIDC Hybrid Flow (_response_type_: `code id_token`) is registered.
98+
*/
99+
id_token_encrypted_response_alg?: string | null;
100+
/**
101+
* JWE `enc` algorithm with which an id_token is to be encrypted.<br/><br/>Required only if OIDC Hybrid Flow (_response_type_: `code id_token`) is registered.
102+
*/
103+
id_token_encrypted_response_enc?: string | null;
104+
/**
105+
* Algorithm with which an id_token is to be signed.
106+
*/
107+
id_token_signed_response_alg: "PS256" | "ES256";
108+
/**
109+
* URL string referencing the client JSON Web Key (JWK) Set **[[RFC7517]](#nref-RFC7517)** document, which contains the client public keys.
110+
*/
111+
jwks_uri: string;
112+
/**
113+
* A unique identifier string assigned by the CDR Register that identifies the Accredited Data Recipient Legal Entity.
114+
*/
115+
legal_entity_id?: string | null;
116+
/**
117+
* Human-readable string name of the Accredited Data Recipient Legal Entity.
118+
*/
119+
legal_entity_name?: string | null;
120+
/**
121+
* URL string that references a logo for the client. If present, the server **SHOULD** display this image to the end-user during approval.
122+
*/
123+
logo_uri: string;
124+
/**
125+
* A unique identifier string assigned by the CDR Register that identifies the Accredited Data Recipient Brand.
126+
*/
127+
org_id: string;
128+
/**
129+
* Human-readable string name of the Accredited Data Recipient to be presented to the end user during authorization.
130+
*/
131+
org_name: string;
132+
/**
133+
* URL string that points to a human-readable policy document for the Software Product.
134+
*/
135+
policy_uri?: string | null;
136+
/**
137+
* Base URI for the Consumer Data Standard Data Recipient endpoints. This should be the base to provide reference to all other Data Recipient Endpoints.
138+
*/
139+
recipient_base_uri?: string | null;
140+
/**
141+
* Array of redirection URI strings for use in redirect-based flows. If used, _redirect_uris_ **MUST** match or be a subset of the _redirect_uris_ as defined in the SSA.
142+
*/
143+
redirect_uris: string[];
144+
/**
145+
* Algorithm which the ADR expects to sign the request object if a request object will be part of the authorization request sent to the Data Holder.
146+
*/
147+
request_object_signing_alg: "PS256" | "ES256";
148+
/**
149+
* Array of the OAuth 2.0 _response_type_ strings that the client can use at the authorization endpoint.<br><br>_response_type_ value `code` is required for Authorization Code Flow.<br>_response_type_ value `code id_token` is required for OIDC Hybrid Flow.
150+
*/
151+
response_types: ("code" | "code id_token")[];
152+
/**
153+
* URI string that references the location of the Software Product consent revocation endpoint.
154+
*/
155+
revocation_uri?: string | null;
156+
/**
157+
* String containing a space-separated list of scope values that the client can use when requesting access tokens.
158+
*/
159+
scope: string;
160+
/**
161+
* URL string referencing the client sector identifier URI, used as an optional input to the Pairwise Identifier.
162+
*/
163+
sector_identifier_uri?: string | null;
164+
/**
165+
* String representing a unique identifier assigned by the Register and used by registration endpoints to identify the software product to be dynamically registered. <br><br>The _software_id_ will remain the same for the lifetime of the product, across multiple updates and versions.
166+
*/
167+
software_id: string;
168+
/**
169+
* String containing a role of the software in the CDR Regime. Initially the only value used will be `data-recipient-software-product`.
170+
*/
171+
software_roles?: "data-recipient-software-product" | null;
172+
/**
173+
* The Software Statement Assertion, as defined in the CDR Data Standards.
174+
*/
175+
software_statement: string;
176+
/**
177+
* The requested authentication method for the token endpoint.
178+
*/
179+
token_endpoint_auth_method: "private_key_jwt";
180+
/**
181+
* The algorithm used for signing the JWT.
182+
*/
183+
token_endpoint_auth_signing_alg: "PS256" | "ES256";
184+
/**
185+
* URL string that points to a human-readable terms of service document for the Software Product.
186+
*/
187+
tos_uri?: string | null;
188188
}

0 commit comments

Comments
 (0)