@affinidi/cli 2.12.0 → 2.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/README.md +0 -1
  2. package/bin/dev.cmd +1 -1
  3. package/bin/dev.js +1 -1
  4. package/dist/commands/generate/app.js.map +1 -1
  5. package/dist/commands/iam/get-policies.d.ts +1 -1
  6. package/dist/commands/iam/get-policies.js.map +1 -1
  7. package/dist/commands/iam/list-principals.d.ts +1 -1
  8. package/dist/commands/iam/list-principals.js.map +1 -1
  9. package/dist/commands/iam/update-policies.d.ts +1 -1
  10. package/dist/commands/iam/update-policies.js.map +1 -1
  11. package/dist/commands/iota/create-config.d.ts +2 -1
  12. package/dist/commands/iota/create-config.js +28 -10
  13. package/dist/commands/iota/create-config.js.map +1 -1
  14. package/dist/commands/iota/update-config.d.ts +0 -1
  15. package/dist/commands/iota/update-config.js +0 -5
  16. package/dist/commands/iota/update-config.js.map +1 -1
  17. package/dist/commands/issuance/create-config.d.ts +2 -0
  18. package/dist/commands/issuance/create-config.js +32 -1
  19. package/dist/commands/issuance/create-config.js.map +1 -1
  20. package/dist/commands/issuance/update-config.d.ts +2 -0
  21. package/dist/commands/issuance/update-config.js +40 -2
  22. package/dist/commands/issuance/update-config.js.map +1 -1
  23. package/dist/commands/login/add-user-to-group.d.ts +3 -1
  24. package/dist/commands/login/add-user-to-group.js +14 -2
  25. package/dist/commands/login/add-user-to-group.js.map +1 -1
  26. package/dist/commands/login/create-config.d.ts +1 -1
  27. package/dist/commands/login/create-config.js +1 -1
  28. package/dist/commands/login/create-config.js.map +1 -1
  29. package/dist/commands/login/create-group.d.ts +1 -1
  30. package/dist/commands/login/create-group.js.map +1 -1
  31. package/dist/commands/login/get-config.d.ts +1 -1
  32. package/dist/commands/login/get-config.js.map +1 -1
  33. package/dist/commands/login/get-group.d.ts +1 -1
  34. package/dist/commands/login/get-group.js.map +1 -1
  35. package/dist/commands/login/import-configs.d.ts +1 -1
  36. package/dist/commands/login/import-configs.js +1 -1
  37. package/dist/commands/login/import-configs.js.map +1 -1
  38. package/dist/commands/login/import-groups.d.ts +1 -1
  39. package/dist/commands/login/import-groups.js.map +1 -1
  40. package/dist/commands/login/list-configs.d.ts +1 -1
  41. package/dist/commands/login/list-configs.js.map +1 -1
  42. package/dist/commands/login/list-groups.d.ts +1 -1
  43. package/dist/commands/login/list-groups.js.map +1 -1
  44. package/dist/commands/login/list-users-in-group.d.ts +1 -1
  45. package/dist/commands/login/list-users-in-group.js +1 -4
  46. package/dist/commands/login/list-users-in-group.js.map +1 -1
  47. package/dist/commands/login/update-config.d.ts +1 -1
  48. package/dist/commands/login/update-config.js +1 -1
  49. package/dist/commands/login/update-config.js.map +1 -1
  50. package/dist/commands/project/create-project.d.ts +1 -1
  51. package/dist/commands/project/create-project.js.map +1 -1
  52. package/dist/commands/project/get-active-project.d.ts +1 -1
  53. package/dist/commands/project/get-active-project.js.map +1 -1
  54. package/dist/commands/project/list-projects.d.ts +1 -1
  55. package/dist/commands/project/list-projects.js.map +1 -1
  56. package/dist/commands/project/select-project.d.ts +1 -1
  57. package/dist/commands/project/select-project.js.map +1 -1
  58. package/dist/commands/project/update-project.d.ts +1 -1
  59. package/dist/commands/project/update-project.js +1 -2
  60. package/dist/commands/project/update-project.js.map +1 -1
  61. package/dist/commands/token/create-token.d.ts +1 -1
  62. package/dist/commands/token/create-token.js.map +1 -1
  63. package/dist/commands/token/get-token.d.ts +1 -1
  64. package/dist/commands/token/get-token.js.map +1 -1
  65. package/dist/commands/token/list-tokens.d.ts +1 -1
  66. package/dist/commands/token/list-tokens.js.map +1 -1
  67. package/dist/commands/token/update-token.d.ts +1 -1
  68. package/dist/commands/token/update-token.js.map +1 -1
  69. package/dist/helpers/token.d.ts +5 -5
  70. package/dist/helpers/token.js.map +1 -1
  71. package/dist/services/affinidi/bff-service.d.ts +2 -2
  72. package/dist/services/affinidi/bff-service.js +2 -2
  73. package/dist/services/affinidi/bff-service.js.map +1 -1
  74. package/dist/services/affinidi/iam/service.d.ts +9 -6
  75. package/dist/services/affinidi/iam/service.js +23 -39
  76. package/dist/services/affinidi/iam/service.js.map +1 -1
  77. package/dist/services/affinidi/vp-adapter/service.d.ts +8 -11
  78. package/dist/services/affinidi/vp-adapter/service.js +22 -40
  79. package/dist/services/affinidi/vp-adapter/service.js.map +1 -1
  80. package/package.json +16 -13
  81. package/dist/services/affinidi/iam/iam.api.d.ts +0 -475
  82. package/dist/services/affinidi/iam/iam.api.js +0 -336
  83. package/dist/services/affinidi/iam/iam.api.js.map +0 -1
  84. package/dist/services/affinidi/vp-adapter/vp-adapter.api.d.ts +0 -1025
  85. package/dist/services/affinidi/vp-adapter/vp-adapter.api.js +0 -681
  86. package/dist/services/affinidi/vp-adapter/vp-adapter.api.js.map +0 -1
@@ -1,1025 +0,0 @@
1
- /** Service Error Response */
2
- export interface ServiceErrorResponse {
3
- /**
4
- * unique id for correlating this specific error to logs
5
- * @format uuid
6
- */
7
- debugId: string;
8
- /** name of the error */
9
- name: string;
10
- /** backwards compatible Affinidi error code */
11
- code: string;
12
- /** error details */
13
- details?: {
14
- /** issue */
15
- issue: string;
16
- /** fields */
17
- field?: string;
18
- /** value */
19
- value?: string;
20
- /** location */
21
- location?: string;
22
- }[];
23
- }
24
- /** Redirect Response */
25
- export interface RedirectResponse {
26
- /** type */
27
- type: 'REDIRECT_RESPONSE';
28
- /**
29
- * URL to redirect to
30
- * @format url
31
- */
32
- to: string;
33
- }
34
- export interface ListLoginConfigurationOutput {
35
- configurations: LoginConfigurationObject[];
36
- lastEvaluatedKey?: string;
37
- }
38
- export interface CreateLoginConfigurationInput {
39
- /** User defined login configuration name */
40
- name: string;
41
- /** OAuth 2.0 Redirect URIs */
42
- redirectUris: string[];
43
- /** VP definition in JSON stringify format */
44
- vpDefinition?: string;
45
- /** Presentation Definition */
46
- presentationDefinition?: object;
47
- /** Fields name/path mapping between the vp_token and the id_token */
48
- idTokenMapping?: IdTokenMapping;
49
- /** login configuration client metadata */
50
- clientMetadata?: LoginConfigurationClientMetadata;
51
- /** ID token claims output format. Default is array. */
52
- claimFormat?: 'array' | 'map';
53
- /**
54
- * Interrupts login process if duplications of data fields names will be found
55
- * @default true
56
- */
57
- failOnMappingConflict?: boolean;
58
- /** List of groups separated by space */
59
- scope?: string;
60
- /** Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_post`: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body. `client_secret_basic`: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP Authorization header. `none`: For public clients (native/mobile apps) which can not have secret. */
61
- tokenEndpointAuthMethod?: TokenEndpointAuthMethod;
62
- }
63
- export interface CreateLoginConfigurationOutput {
64
- /** Configuration ari */
65
- ari: string;
66
- /** Project id */
67
- projectId: string;
68
- /** Configuration id */
69
- configurationId?: string;
70
- /** User defined login configuration name */
71
- name: string;
72
- /** OIDC Auth Credentials */
73
- auth: {
74
- /** OAuth 2.0 Client ID */
75
- clientId: string;
76
- /** OAuth 2.0 Client Secret */
77
- clientSecret?: string;
78
- /** OAuth 2.0 Client Scope */
79
- scope?: string;
80
- /** Issuer URL */
81
- issuer?: string;
82
- };
83
- /** OAuth 2.0 Redirect URIs */
84
- redirectUris: string[];
85
- /** login configuration client metadata */
86
- clientMetadata: LoginConfigurationClientMetadata;
87
- /** OAuth 2.0 Client Creation Date */
88
- creationDate: string;
89
- }
90
- export type GetLoginConfigurationOutput = LoginConfigurationObject;
91
- export interface UpdateLoginConfigurationInput {
92
- /** User defined login configuration name */
93
- name?: string;
94
- /** OAuth 2.0 Redirect URIs */
95
- redirectUris?: string[];
96
- /** OAuth2 client secret */
97
- clientSecret?: string;
98
- /** VP definition in JSON stringify format */
99
- vpDefinition?: string;
100
- /** Presentation Definition */
101
- presentationDefinition?: object;
102
- /** Fields name/path mapping between the vp_token and the id_token */
103
- idTokenMapping?: IdTokenMapping;
104
- /** login configuration client metadata */
105
- clientMetadata?: LoginConfigurationClientMetadata;
106
- /** Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_post`: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body. `client_secret_basic`: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP Authorization header. `none`: For public clients (native/mobile apps) which can not have secret. */
107
- tokenEndpointAuthMethod?: TokenEndpointAuthMethod;
108
- /** Interrupts login process if duplications of data fields names will be found */
109
- failOnMappingConflict?: boolean;
110
- }
111
- export type UpdateLoginConfigurationOutput = LoginConfigurationObject;
112
- export interface LoginSessionDto {
113
- /** Session primary identifier */
114
- id: string;
115
- authorizationRequest: {
116
- /** State parameter */
117
- state: string;
118
- /** Presentation Definition to ask from the user. In JSON Stringify format. */
119
- presentationDefinition: string;
120
- /** ARI is used for analytics proposals. */
121
- ari?: string;
122
- /** clientId used for detect origin. */
123
- clientId?: string;
124
- };
125
- }
126
- /** Input for Creating a Login Session */
127
- export interface LoginSessionForIDPInput {
128
- /** IDP Login Challenge to Associate the Session with */
129
- loginChallenge: string;
130
- /** IDP client id to Associate the Session with */
131
- clientId: string;
132
- }
133
- export type LoginSessionForIDPOutput = LoginSessionDto;
134
- /** Authorization Response per OpenID for Verifiable Presentations Specification */
135
- export type LoginSessionAcceptResponseInput = Record<string, any>;
136
- /** Direct Post Response URI endpoint result */
137
- export type LoginSessionAcceptResponseOutput = Record<string, any>;
138
- /** Authorization Response per OpenID for Verifiable Presentations Specification */
139
- export interface LoginSessionRejectResponseInput {
140
- /** The error should follow the OAuth2 error format (e.g. invalid_request, login_required). Defaults to request_denied */
141
- error?: string;
142
- /** Description of the error in a human readable format */
143
- errorDescription?: string;
144
- /** Random state associated to the Session */
145
- state: string;
146
- [key: string]: any;
147
- }
148
- /** Direct Post Response URI endpoint result */
149
- export type LoginSessionRejectResponseOutput = Record<string, any>;
150
- export interface LoginConfigurationObject {
151
- /** Configuration ari */
152
- ari: string;
153
- /** Configuration id */
154
- configurationId?: string;
155
- /** Project id */
156
- projectId: string;
157
- /** User defined login configuration name */
158
- name: string;
159
- /** OAuth 2.0 Redirect URIs */
160
- redirectUris?: string[];
161
- /** OAuth 2.0 Client Scope */
162
- scope?: string;
163
- /** OAuth 2.0 Client ID */
164
- clientId: string;
165
- /** OAuth 2.0 Client Creation Date */
166
- creationDate: string;
167
- /** VP definition in JSON stringify format */
168
- vpDefinition: string;
169
- /** Presentation Definition */
170
- presentationDefinition?: object;
171
- /** Fields name/path mapping between the vp_token and the id_token */
172
- idTokenMapping: IdTokenMapping;
173
- /** login configuration client metadata */
174
- clientMetadata: LoginConfigurationClientMetadata;
175
- /** Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_post`: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body. `client_secret_basic`: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP Authorization header. `none`: For public clients (native/mobile apps) which can not have secret. */
176
- tokenEndpointAuthMethod: TokenEndpointAuthMethod;
177
- [key: string]: any;
178
- }
179
- /**
180
- * Fields name/path mapping between the vp_token and the id_token
181
- * @minItems 1
182
- */
183
- export type IdTokenMapping = {
184
- /** Name(path) of the corresponding field in the vp_token */
185
- sourceField: string;
186
- /** Name of the corresponding field in the id_token */
187
- idTokenClaim: string;
188
- /** Id of related input descriptor from presentation definition */
189
- inputDescriptorId?: string;
190
- }[];
191
- export interface CreateGroupInput {
192
- /**
193
- * name of the group for users, used as an id
194
- * @maxLength 24
195
- * @pattern ^[a-z_]+$
196
- */
197
- groupName: string;
198
- }
199
- export interface GroupDto {
200
- /** Group ari */
201
- ari: string;
202
- /** Project id */
203
- projectId: string;
204
- /** name of the group, identifier within a project */
205
- groupName: string;
206
- /** Group creation date */
207
- creationDate: string;
208
- }
209
- export interface GroupUserMappingDto {
210
- /** Unique identifier of the user */
211
- userId: string;
212
- /** Group to user mapping creation date */
213
- addedAt: string;
214
- }
215
- /** input used to add a user to a group */
216
- export interface AddUserToGroupInput {
217
- /** Unique identifier of the user */
218
- userId: string;
219
- }
220
- /** input used to remove a user from a group */
221
- export interface RemoveUserFromGroupInput {
222
- /** Unique identifier of the user */
223
- userId: string;
224
- }
225
- export interface GroupsList {
226
- groups?: GroupDto[];
227
- }
228
- export interface GroupUserMappingsList {
229
- users?: GroupUserMappingDto[];
230
- lastEvaluatedKey?: string;
231
- totalUserCount?: number;
232
- }
233
- /** login configuration client metadata */
234
- export interface LoginConfigurationClientMetadata {
235
- /** application name that will be displayed in consent page */
236
- name: string;
237
- /** origin url that will be displayed in consent page */
238
- origin: string;
239
- /** logo url that will be displayed in consent page */
240
- logo: string;
241
- [key: string]: any;
242
- }
243
- /** Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_post`: (default) Send client_id and client_secret as application/x-www-form-urlencoded in the HTTP body. `client_secret_basic`: Send client_id and client_secret as application/x-www-form-urlencoded encoded in the HTTP Authorization header. `none`: For public clients (native/mobile apps) which can not have secret. */
244
- export declare enum TokenEndpointAuthMethod {
245
- ClientSecretBasic = "client_secret_basic",
246
- ClientSecretPost = "client_secret_post",
247
- None = "none"
248
- }
249
- export interface InvalidParameterError {
250
- name: 'InvalidParameterError';
251
- message: 'Invalid parameter: ${param}.';
252
- httpStatusCode: 400;
253
- traceId: string;
254
- details?: {
255
- issue: string;
256
- field?: string;
257
- value?: string;
258
- location?: string;
259
- }[];
260
- }
261
- export interface NotFoundError {
262
- name: 'NotFoundError';
263
- message: 'Not found: ${param}.';
264
- httpStatusCode: 404;
265
- traceId: string;
266
- details?: {
267
- issue: string;
268
- field?: string;
269
- value?: string;
270
- location?: string;
271
- }[];
272
- }
273
- export interface JsonWebKey {
274
- /** The value of the "keys" parameter is an array of JSON Web Key (JWK) values. By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. */
275
- keys?: {
276
- /** The "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name. */
277
- alg: string;
278
- crv?: string;
279
- d?: string;
280
- dp?: string;
281
- dq?: string;
282
- e?: string;
283
- k?: string;
284
- /** The "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string. */
285
- kid: string;
286
- /** The "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string. */
287
- kty: string;
288
- n?: string;
289
- p?: string;
290
- q?: string;
291
- qi?: string;
292
- /** Use ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption). */
293
- use: string;
294
- x?: string;
295
- /** The "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. */
296
- x5c: string[];
297
- y?: string;
298
- }[];
299
- }
300
- export interface OIDCConfig {
301
- /** OAuth 2.0 Authorization Endpoint URL */
302
- authorization_endpoint: string;
303
- /** OpenID Connect Back-Channel Logout Session Required. Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP */
304
- backchannel_logout_session_supported?: boolean;
305
- /** OpenID Connect Back-Channel Logout Supported. Boolean value specifying whether the OP supports back-channel logout, with true indicating support. */
306
- backchannel_logout_supported?: boolean;
307
- /** OpenID Connect Claims Parameter Parameter Supported Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. */
308
- claims_parameter_supported?: boolean;
309
- /** OpenID Connect Supported Claims JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. */
310
- claims_supported?: string[];
311
- /** OAuth 2.0 PKCE Supported Code Challenge Methods JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server. */
312
- code_challenge_methods_supported?: string[];
313
- /** OpenID Connect Verifiable Credentials Endpoint Contains the URL of the Verifiable Credentials Endpoint. */
314
- credentials_endpoint_draft_00?: string;
315
- /** OpenID Connect Verifiable Credentials Supported JSON array containing a list of the Verifiable Credentials supported by this authorization server. */
316
- credentials_supported_draft_00?: {
317
- cryptographic_binding_methods_supported?: string[];
318
- cryptographic_suites_supported?: string[];
319
- format?: string;
320
- types?: string[];
321
- }[];
322
- /** OpenID Connect End-Session Endpoint URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP. */
323
- end_session_endpoint?: string;
324
- /** OpenID Connect Front-Channel Logout Session Required Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP. */
325
- frontchannel_logout_session_supported?: boolean;
326
- /** OpenID Connect Front-Channel Logout Supported Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support. */
327
- frontchannel_logout_supported?: boolean;
328
- /** OAuth 2.0 Supported Grant Types JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. */
329
- grant_types_supported?: string[];
330
- /**
331
- * OpenID Connect Default ID Token Signing Algorithms
332
- * Algorithm used to sign OpenID Connect ID Tokens.
333
- */
334
- id_token_signed_response_alg: string[];
335
- /**
336
- * OpenID Connect Supported ID Token Signing Algorithms
337
- * JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT.
338
- */
339
- id_token_signing_alg_values_supported: string[];
340
- /**
341
- * OpenID Connect Issuer URL
342
- * An URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL.
343
- */
344
- issuer: string;
345
- /**
346
- * OpenID Connect Well-Known JSON Web Keys URL
347
- * URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
348
- */
349
- jwks_uri: string;
350
- /** OpenID Connect Dynamic Client Registration Endpoint URL */
351
- registration_endpoint?: string;
352
- /**
353
- * OpenID Connect Supported Request Object Signing Algorithms
354
- * JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter).
355
- */
356
- request_object_signing_alg_values_supported?: string[];
357
- /**
358
- * OpenID Connect Request Parameter Supported
359
- * Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
360
- */
361
- request_parameter_supported?: boolean;
362
- /**
363
- * OpenID Connect Request URI Parameter Supported
364
- * Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
365
- */
366
- request_uri_parameter_supported?: boolean;
367
- /**
368
- * OpenID Connect Requires Request URI Registration
369
- * Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.
370
- */
371
- require_request_uri_registration?: boolean;
372
- /**
373
- * OAuth 2.0 Supported Response Modes
374
- * JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
375
- */
376
- response_modes_supported?: string[];
377
- /**
378
- * OAuth 2.0 Supported Response Types
379
- * JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values.
380
- */
381
- response_types_supported: string[];
382
- /**
383
- * OAuth 2.0 Token Revocation URL
384
- * URL of the authorization server's OAuth 2.0 revocation endpoint.
385
- */
386
- revocation_endpoint?: string;
387
- /**
388
- * OAuth 2.0 Supported Scope Values
389
- * JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used
390
- */
391
- scopes_supported?: string[];
392
- /**
393
- * OpenID Connect Supported Subject Types
394
- * JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.
395
- */
396
- subject_types_supported: string[];
397
- /** OAuth 2.0 Token Endpoint URL */
398
- token_endpoint: string;
399
- /**
400
- * OAuth 2.0 Supported Client Authentication Methods
401
- * JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0
402
- */
403
- token_endpoint_auth_methods_supported?: string[];
404
- /**
405
- * OpenID Connect Userinfo URL
406
- * URL of the OP's UserInfo Endpoint.
407
- */
408
- userinfo_endpoint?: string;
409
- /**
410
- * OpenID Connect User Userinfo Signing Algorithm
411
- * Algorithm used to sign OpenID Connect Userinfo Responses.
412
- */
413
- userinfo_signed_response_alg: string[];
414
- /**
415
- * OpenID Connect Supported Userinfo Signing Algorithm
416
- * JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
417
- */
418
- userinfo_signing_alg_values_supported?: string[];
419
- }
420
- export interface OAuth2Token {
421
- /** The access token issued by the authorization server. */
422
- access_token?: string;
423
- /** The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated. */
424
- expires_in?: number;
425
- /** To retrieve a refresh token request the id_token scope. */
426
- id_token?: number;
427
- /** The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope "offline" to your access token request. */
428
- refresh_token?: string;
429
- /** The scope of the access token */
430
- scope?: string;
431
- /** The type of the token issued */
432
- token_type?: string;
433
- }
434
- export interface GetUserInfo {
435
- /** End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates. */
436
- birthdate?: string;
437
- /** End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. */
438
- email?: string;
439
- /** True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. */
440
- email_verified?: boolean;
441
- /** Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters. */
442
- family_name?: string;
443
- /** End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable. */
444
- gender?: string;
445
- /** Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters. */
446
- given_name?: string;
447
- /** End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well. */
448
- locale?: string;
449
- /** Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used. */
450
- middle_name?: string;
451
- /** End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. */
452
- name?: string;
453
- /** Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael. */
454
- nickname?: string;
455
- /** End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678. */
456
- phone_number?: string;
457
- /** True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format. */
458
- phone_number_verified?: boolean;
459
- /** URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User. */
460
- picture?: string;
461
- /** Non-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. */
462
- preferred_username?: string;
463
- /** URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. */
464
- profile?: string;
465
- /** Subject - Identifier for the End-User at the IssuerURL. */
466
- sub?: string;
467
- /** Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time. */
468
- updated_at?: number;
469
- /** URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with. */
470
- website?: string;
471
- /** String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. */
472
- zoneinfo?: string;
473
- }
474
- export interface ErrorOAuth2 {
475
- /** Error */
476
- error: string;
477
- /** Error Debug Information. Only available in dev mode. */
478
- error_debug?: string;
479
- /** Error Description */
480
- error_description: string;
481
- /** Error Hint. Helps the user identify the error cause. */
482
- error_hint?: string;
483
- /** HTTP Status Code */
484
- status_code: string;
485
- }
486
- export interface ResourceCreationError {
487
- name: 'ResourceCreationError';
488
- message: 'Failed to create resources.';
489
- httpStatusCode: 424;
490
- traceId: string;
491
- details?: {
492
- issue: string;
493
- field?: string;
494
- value?: string;
495
- location?: string;
496
- }[];
497
- }
498
- export interface GroupsPerUserLimitExceededError {
499
- name: 'GroupsPerUserLimitExceededError';
500
- message: 'Amount of groups per user is limited.';
501
- httpStatusCode: 409;
502
- traceId: string;
503
- details?: {
504
- issue: string;
505
- field?: string;
506
- value?: string;
507
- location?: string;
508
- }[];
509
- }
510
- export interface ActionForbiddenError {
511
- name: 'ActionForbiddenError';
512
- message: 'Principal can not execute action on given resource';
513
- httpStatusCode: 403;
514
- traceId: string;
515
- details?: {
516
- issue: string;
517
- field?: string;
518
- value?: string;
519
- location?: string;
520
- }[];
521
- }
522
- export interface VPTokenValidationError {
523
- name: 'VPTokenValidationError';
524
- message: 'VP token validation ended with an error';
525
- httpStatusCode: 400;
526
- traceId: string;
527
- details?: {
528
- issue: string;
529
- field?: string;
530
- value?: string;
531
- location?: string;
532
- }[];
533
- }
534
- export interface GroupNamesInput {
535
- /** @maxItems 25 */
536
- groupNames: string[];
537
- }
538
- export interface GroupNames {
539
- groupNames: string[];
540
- pageToken?: object;
541
- }
542
- export interface BlockedUsersInput {
543
- /** @maxItems 25 */
544
- userIds: string[];
545
- }
546
- export interface BlockedUsers {
547
- userIds: string[];
548
- pageToken?: object;
549
- }
550
- export interface InvalidGroupsError {
551
- name: 'InvalidGroupsError';
552
- message: 'Invalid groups names';
553
- httpStatusCode: 400;
554
- traceId: string;
555
- details?: {
556
- issue: string;
557
- field?: string;
558
- value?: string;
559
- location?: string;
560
- }[];
561
- }
562
- export interface LoginConfigurationReadInvalidClientIdError {
563
- name: 'LoginConfigurationReadInvalidClientIdError';
564
- message: 'LoginConfigurationReadInvalidClientIdError';
565
- httpStatusCode: 400;
566
- traceId: string;
567
- details?: {
568
- issue: string;
569
- field?: string;
570
- value?: string;
571
- location?: string;
572
- }[];
573
- }
574
- import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
575
- export type QueryParamsType = Record<string | number, any>;
576
- export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
577
- /** set parameter to `true` for call `securityWorker` for this request */
578
- secure?: boolean;
579
- /** request path */
580
- path: string;
581
- /** content type of request body */
582
- type?: ContentType;
583
- /** query params */
584
- query?: QueryParamsType;
585
- /** format of response (i.e. response.json() -> format: "json") */
586
- format?: ResponseType;
587
- /** request body */
588
- body?: unknown;
589
- }
590
- export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
591
- export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
592
- securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
593
- secure?: boolean;
594
- format?: ResponseType;
595
- }
596
- export declare enum ContentType {
597
- Json = "application/json",
598
- FormData = "multipart/form-data",
599
- UrlEncoded = "application/x-www-form-urlencoded",
600
- Text = "text/plain"
601
- }
602
- export declare class HttpClient<SecurityDataType = unknown> {
603
- instance: AxiosInstance;
604
- private securityData;
605
- private securityWorker?;
606
- private secure?;
607
- private format?;
608
- constructor({ securityWorker, secure, format, ...axiosConfig }?: ApiConfig<SecurityDataType>);
609
- setSecurityData: (data: SecurityDataType | null) => void;
610
- protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
611
- protected stringifyFormItem(formItem: unknown): string;
612
- protected createFormData(input: Record<string, unknown>): FormData;
613
- request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T>>;
614
- }
615
- /**
616
- * @title OidcVpAdapterBackend
617
- * @version 1.0.0
618
- * @baseUrl /
619
- * @contact nucleus <nucleus.team@affinidi.com>
620
- *
621
- * Affinidi OIDC VP Adapter Backend
622
- *
623
- * An authorization token is necessary to create or obtain a project Access Token and access Admin APIs. Follow these step-by-step [instructions](https://lemmatree.atlassian.net/wiki/spaces/NETCORE/pages/2735317648020/ASA+Developer+Flow#Instructions-on-how-to-create-the-Project.) to set up an authorization token
624
- */
625
- export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
626
- v1: {
627
- /**
628
- * @description IDP consent request automated by adapter frontend
629
- *
630
- * @tags consent
631
- * @name ConsentRequest
632
- * @summary IDP consent request automated by adapter frontend
633
- * @request GET:/v1/consent/request
634
- */
635
- consentRequest: (query?: {
636
- /** Consent challenge provided by IDP */
637
- consent_challenge?: string;
638
- }, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
639
- /**
640
- * @description Creates Login Session for IDP Login by using the Login Challenge
641
- *
642
- * @tags session
643
- * @name LoginSessionForIdp
644
- * @summary Create Login Session for IDP Login
645
- * @request POST:/v1/login/sessions/for-idp
646
- */
647
- loginSessionForIdp: (data: LoginSessionForIDPInput, params?: RequestParams) => Promise<AxiosResponse<LoginSessionDto, any>>;
648
- /**
649
- * @description Enable CORS by returning correct headers
650
- *
651
- * @tags cors
652
- * @name CorsLoginSessionForIdp
653
- * @summary CORS Support
654
- * @request OPTIONS:/v1/login/sessions/for-idp
655
- */
656
- corsLoginSessionForIdp: (params?: RequestParams) => Promise<AxiosResponse<any, any>>;
657
- /**
658
- * @description Accepts and Validates the OIDC VP Response sent by the Wallet
659
- *
660
- * @tags session
661
- * @name LoginSessionAcceptResponse
662
- * @summary Accept OIDC VP Response for Login Session
663
- * @request POST:/v1/login/sessions/{sessionId}/accept-response
664
- */
665
- loginSessionAcceptResponse: (sessionId: string, data: LoginSessionAcceptResponseInput, params?: RequestParams) => Promise<AxiosResponse<LoginSessionAcceptResponseOutput, any>>;
666
- /**
667
- * @description Enable CORS by returning correct headers
668
- *
669
- * @tags cors
670
- * @name CorsLoginSessionAcceptResponse
671
- * @summary CORS Support
672
- * @request OPTIONS:/v1/login/sessions/{sessionId}/accept-response
673
- */
674
- corsLoginSessionAcceptResponse: (sessionId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
675
- /**
676
- * @description The user declines the request for access to their data
677
- *
678
- * @tags session
679
- * @name LoginSessionRejectResponse
680
- * @summary Reject Response for Login Session
681
- * @request POST:/v1/login/sessions/{sessionId}/reject-response
682
- */
683
- loginSessionRejectResponse: (sessionId: string, data: LoginSessionRejectResponseInput, params?: RequestParams) => Promise<AxiosResponse<LoginSessionRejectResponseOutput, any>>;
684
- /**
685
- * @description Enable CORS by returning correct headers
686
- *
687
- * @tags cors
688
- * @name CorsLoginSessionRejectResponse
689
- * @summary CORS Support
690
- * @request OPTIONS:/v1/login/sessions/{sessionId}/reject-response
691
- */
692
- corsLoginSessionRejectResponse: (sessionId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
693
- /**
694
- * @description Endpoint to retrieve list of login configurations
695
- *
696
- * @tags configuration
697
- * @name ListLoginConfigurations
698
- * @summary List login configurations
699
- * @request GET:/v1/login/configurations
700
- * @secure
701
- */
702
- listLoginConfigurations: (query?: {
703
- /**
704
- * Maximum number of records to fetch in a list
705
- * @min 1
706
- * @max 100
707
- */
708
- limit?: number;
709
- /**
710
- * The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.
711
- * @maxLength 3000
712
- */
713
- exclusiveStartKey?: string;
714
- }, params?: RequestParams) => Promise<AxiosResponse<ListLoginConfigurationOutput, any>>;
715
- /**
716
- * @description Create a new login configuration `vpDefinition` and `idTokenMapping` have default settings that provide user email VP presentation definitions. An essential default definition is in place when it comes to the login process for end users using the Chrome extension. This definition requires users to input their email address as OIDCVP compliant, which is then verified by the Affinidi verification service.
717
- *
718
- * @tags configuration
719
- * @name CreateLoginConfigurations
720
- * @summary Create a new login configuration
721
- * @request POST:/v1/login/configurations
722
- * @secure
723
- */
724
- createLoginConfigurations: (data: CreateLoginConfigurationInput, params?: RequestParams) => Promise<AxiosResponse<CreateLoginConfigurationOutput, any>>;
725
- /**
726
- * @description Get login configuration by ID
727
- *
728
- * @tags configuration
729
- * @name GetLoginConfigurationsById
730
- * @summary Get login configuration by ID
731
- * @request GET:/v1/login/configurations/{configurationId}
732
- * @secure
733
- */
734
- getLoginConfigurationsById: (configurationId: string, params?: RequestParams) => Promise<AxiosResponse<LoginConfigurationObject, any>>;
735
- /**
736
- * @description Update login configurations by ID
737
- *
738
- * @tags configuration
739
- * @name UpdateLoginConfigurationsById
740
- * @summary Update login configurations by ID
741
- * @request PATCH:/v1/login/configurations/{configurationId}
742
- * @secure
743
- */
744
- updateLoginConfigurationsById: (configurationId: string, data: UpdateLoginConfigurationInput, params?: RequestParams) => Promise<AxiosResponse<LoginConfigurationObject, any>>;
745
- /**
746
- * @description Delete login configurations by ID
747
- *
748
- * @tags configuration
749
- * @name DeleteLoginConfigurationsById
750
- * @summary Delete login configurations by ID
751
- * @request DELETE:/v1/login/configurations/{configurationId}
752
- * @secure
753
- */
754
- deleteLoginConfigurationsById: (configurationId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
755
- /**
756
- * @description Get Client Metadata By OAuth 2.0 Client ID
757
- *
758
- * @tags configuration
759
- * @name GetClientMetadataByClientId
760
- * @summary Get Client Metadata By OAuth 2.0 Client ID
761
- * @request GET:/v1/login/configurations/metadata/{clientId}
762
- */
763
- getClientMetadataByClientId: (clientId: string, params?: RequestParams) => Promise<AxiosResponse<LoginConfigurationClientMetadata, any>>;
764
- /**
765
- * No description
766
- *
767
- * @tags group
768
- * @name ListGroups
769
- * @request GET:/v1/groups
770
- * @secure
771
- */
772
- listGroups: (params?: RequestParams) => Promise<AxiosResponse<GroupsList, any>>;
773
- /**
774
- * No description
775
- *
776
- * @tags group
777
- * @name CreateGroup
778
- * @request POST:/v1/groups
779
- * @secure
780
- */
781
- createGroup: (data: CreateGroupInput, params?: RequestParams) => Promise<AxiosResponse<GroupDto, any>>;
782
- /**
783
- * No description
784
- *
785
- * @tags group
786
- * @name GetGroupById
787
- * @request GET:/v1/groups/{groupName}
788
- * @secure
789
- */
790
- getGroupById: (groupName: string, params?: RequestParams) => Promise<AxiosResponse<GroupDto, any>>;
791
- /**
792
- * No description
793
- *
794
- * @tags group
795
- * @name DeleteGroup
796
- * @request DELETE:/v1/groups/{groupName}
797
- * @secure
798
- */
799
- deleteGroup: (groupName: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
800
- /**
801
- * No description
802
- *
803
- * @tags group
804
- * @name ListGroupUserMappings
805
- * @request GET:/v1/groups/{groupName}/users
806
- * @secure
807
- */
808
- listGroupUserMappings: (groupName: string, query?: {
809
- /**
810
- * Maximum number of records to fetch in a list
811
- * @min 1
812
- * @max 100
813
- */
814
- limit?: number;
815
- /**
816
- * The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation.
817
- * @maxLength 3000
818
- */
819
- exclusiveStartKey?: string;
820
- }, params?: RequestParams) => Promise<AxiosResponse<GroupUserMappingsList, any>>;
821
- /**
822
- * No description
823
- *
824
- * @tags group
825
- * @name AddUserToGroup
826
- * @request POST:/v1/groups/{groupName}/users
827
- * @secure
828
- */
829
- addUserToGroup: (groupName: string, data: AddUserToGroupInput, params?: RequestParams) => Promise<AxiosResponse<GroupUserMappingDto, any>>;
830
- /**
831
- * No description
832
- *
833
- * @tags group
834
- * @name RemoveUserFromGroup
835
- * @request DELETE:/v1/groups/{groupName}/users
836
- * @secure
837
- */
838
- removeUserFromGroup: (groupName: string, data: RemoveUserFromGroupInput, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
839
- /**
840
- * @description Block Single or Multiple Groups
841
- *
842
- * @tags deny-list
843
- * @name BlockGroups
844
- * @request POST:/v1/deny-list/groups/add
845
- * @secure
846
- */
847
- blockGroups: (data: GroupNames, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
848
- /**
849
- * @description Get Blocked Groups
850
- *
851
- * @tags deny-list
852
- * @name ListBlockedGroups
853
- * @request GET:/v1/deny-list/groups
854
- * @secure
855
- */
856
- listBlockedGroups: (query?: {
857
- pageToken?: string;
858
- }, params?: RequestParams) => Promise<AxiosResponse<GroupNames, any>>;
859
- /**
860
- * @description Unblock Single or Multiple Groups
861
- *
862
- * @tags deny-list
863
- * @name UnblockGroups
864
- * @request POST:/v1/deny-list/groups/remove
865
- * @secure
866
- */
867
- unblockGroups: (data: GroupNames, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
868
- /**
869
- * @description Block Single or Multiple user ids
870
- *
871
- * @tags deny-list
872
- * @name BlockUsers
873
- * @request POST:/v1/deny-list/users/add
874
- * @secure
875
- */
876
- blockUsers: (data: BlockedUsers, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
877
- /**
878
- * @description Get List of Blocked Users
879
- *
880
- * @tags deny-list
881
- * @name ListBlockedUsers
882
- * @request GET:/v1/deny-list/users
883
- * @secure
884
- */
885
- listBlockedUsers: (query?: {
886
- pageToken?: string;
887
- }, params?: RequestParams) => Promise<AxiosResponse<BlockedUsers, any>>;
888
- /**
889
- * @description Unblock Single or Multiple user ids
890
- *
891
- * @tags deny-list
892
- * @name UnblockUsers
893
- * @request POST:/v1/deny-list/users/remove
894
- * @secure
895
- */
896
- unblockUsers: (data: BlockedUsers, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
897
- /**
898
- * @description Allow Single or Multiple Groups
899
- *
900
- * @tags allow-list
901
- * @name AllowGroups
902
- * @request POST:/v1/allow-list/groups/add
903
- * @secure
904
- */
905
- allowGroups: (data: GroupNames, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
906
- /**
907
- * @description Get Allowed Groups
908
- *
909
- * @tags allow-list
910
- * @name ListAllowedGroups
911
- * @request GET:/v1/allow-list/groups
912
- * @secure
913
- */
914
- listAllowedGroups: (query?: {
915
- pageToken?: string;
916
- }, params?: RequestParams) => Promise<AxiosResponse<GroupNames, any>>;
917
- /**
918
- * @description Disallow Single or Multiple Groups
919
- *
920
- * @tags allow-list
921
- * @name DisallowGroups
922
- * @request POST:/v1/allow-list/groups/remove
923
- * @secure
924
- */
925
- disallowGroups: (data: GroupNames, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
926
- /**
927
- * No description
928
- *
929
- * @name LoginAdminProxyList
930
- * @request GET:/v1/login/admin/{proxy+}
931
- */
932
- loginAdminProxyList: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
933
- /**
934
- * No description
935
- *
936
- * @name LoginAdminProxyCreate
937
- * @request POST:/v1/login/admin/{proxy+}
938
- */
939
- loginAdminProxyCreate: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
940
- /**
941
- * No description
942
- *
943
- * @name LoginAdminProxyDelete
944
- * @request DELETE:/v1/login/admin/{proxy+}
945
- */
946
- loginAdminProxyDelete: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
947
- /**
948
- * No description
949
- *
950
- * @name LoginAdminProxyUpdate
951
- * @request PUT:/v1/login/admin/{proxy+}
952
- */
953
- loginAdminProxyUpdate: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
954
- /**
955
- * No description
956
- *
957
- * @name LoginAdminProxyPartialUpdate
958
- * @request PATCH:/v1/login/admin/{proxy+}
959
- */
960
- loginAdminProxyPartialUpdate: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
961
- /**
962
- * @description This endpoint returns JSON Web Keys required to verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like node-jwks-rsa among others.
963
- *
964
- * @tags idp
965
- * @name LoginProjectWellKnownJwksJsonDetail
966
- * @summary Discover Well-Known JSON Web Keys
967
- * @request GET:/v1/login/project/{projectId}/.well-known/jwks.json
968
- */
969
- loginProjectWellKnownJwksJsonDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<JsonWebKey, any>>;
970
- /**
971
- * @description A mechanism for an OpenID Connect Relying Party to discover the End-User's OpenID Provider and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations.
972
- *
973
- * @tags idp
974
- * @name LoginProjectWellKnownOpenidConfigurationDetail
975
- * @summary OpenID Connect Discovery
976
- * @request GET:/v1/login/project/{projectId}/.well-known/openid-configuration
977
- */
978
- loginProjectWellKnownOpenidConfigurationDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<OIDCConfig, any>>;
979
- /**
980
- * @description The authorization endpoint is one of the components in the OAuth 2.0 flow. It's the URL where a user is redirected to grant or deny access to their resources. When a user tries to access a service that requires OAuth 2.0 authorization, the application will redirect the user to this authorization endpoint. Here, the user can log in (if necessary) and then decide whether to grant the application access.
981
- *
982
- * @tags idp
983
- * @name LoginProjectOauth2AuthDetail
984
- * @summary OAuth 2.0 Authorize Endpoint
985
- * @request GET:/v1/login/project/{projectId}/oauth2/auth
986
- */
987
- loginProjectOauth2AuthDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
988
- /**
989
- * @description Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.
990
- *
991
- * @tags idp
992
- * @name LoginProjectOauth2RevokeCreate
993
- * @summary Revoke OAuth 2.0 Access or Refresh Token
994
- * @request POST:/v1/login/project/{projectId}/oauth2/revoke
995
- */
996
- loginProjectOauth2RevokeCreate: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
997
- /**
998
- * @description This endpoint initiates and completes user logout at the IdP OAuth2 & OpenID provider and initiates OpenID Connect Front- / Back-channel logout: https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html Back-channel logout is performed asynchronously and does not affect logout flow.
999
- *
1000
- * @tags idp
1001
- * @name LoginProjectOauth2SessionsLogoutDetail
1002
- * @summary OpenID Connect Front- and Back-channel Enabled Logout
1003
- * @request GET:/v1/login/project/{projectId}/oauth2/sessions/logout
1004
- */
1005
- loginProjectOauth2SessionsLogoutDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
1006
- /**
1007
- * @description The token endpoint is a critical component in the OAuth 2.0 protocol. It's the URL where a client application makes a request to exchange an authorization grant (such as an authorization code) for an access token. After a user grants authorization at the authorization endpoint, the client application receives an authorization grant, which is then exchanged for an access token at the token endpoint. This access token is then used to access the user's resources on the protected server.
1008
- *
1009
- * @tags idp
1010
- * @name LoginProjectOauth2TokenCreate
1011
- * @summary The OAuth 2.0 Token Endpoint
1012
- * @request POST:/v1/login/project/{projectId}/oauth2/token
1013
- */
1014
- loginProjectOauth2TokenCreate: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<OAuth2Token, any>>;
1015
- /**
1016
- * @description This endpoint returns the payload of the ID Token, including session.id_token values, of the provided OAuth 2.0 Access Token's consent request. In the case of authentication error, a WWW-Authenticate header might be set in the response with more information about the error. See the spec for more details about header format.
1017
- *
1018
- * @tags idp
1019
- * @name LoginProjectUserinfoDetail
1020
- * @summary OpenID Connect Userinfo
1021
- * @request GET:/v1/login/project/{projectId}/userinfo
1022
- */
1023
- loginProjectUserinfoDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<GetUserInfo, any>>;
1024
- };
1025
- }