@affinidi/cli 2.0.0-beta.9 → 2.0.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.
- package/README.md +138 -54
- package/dist/commands/generate/app.d.ts +5 -0
- package/dist/commands/generate/app.js +54 -59
- package/dist/commands/generate/app.js.map +1 -1
- package/dist/commands/iam/add-principal.js +8 -9
- package/dist/commands/iam/add-principal.js.map +1 -1
- package/dist/commands/iam/get-policies.js +8 -9
- package/dist/commands/iam/get-policies.js.map +1 -1
- package/dist/commands/iam/list-principals.js +1 -2
- package/dist/commands/iam/list-principals.js.map +1 -1
- package/dist/commands/iam/remove-principal.js +8 -9
- package/dist/commands/iam/remove-principal.js.map +1 -1
- package/dist/commands/iam/update-policies.js +18 -17
- package/dist/commands/iam/update-policies.js.map +1 -1
- package/dist/commands/login/add-user-to-group.d.ts +1 -1
- package/dist/commands/login/add-user-to-group.js +9 -10
- package/dist/commands/login/add-user-to-group.js.map +1 -1
- package/dist/commands/login/create-config.js +13 -14
- package/dist/commands/login/create-config.js.map +1 -1
- package/dist/commands/login/create-group.js +3 -4
- package/dist/commands/login/create-group.js.map +1 -1
- package/dist/commands/login/delete-config.js +5 -6
- package/dist/commands/login/delete-config.js.map +1 -1
- package/dist/commands/login/delete-group.js +5 -6
- package/dist/commands/login/delete-group.js.map +1 -1
- package/dist/commands/login/export-configs.d.ts +10 -0
- package/dist/commands/login/export-configs.js +67 -0
- package/dist/commands/login/export-configs.js.map +1 -0
- package/dist/commands/login/export-groups.d.ts +10 -0
- package/dist/commands/login/export-groups.js +64 -0
- package/dist/commands/login/export-groups.js.map +1 -0
- package/dist/commands/login/get-config.js +5 -6
- package/dist/commands/login/get-config.js.map +1 -1
- package/dist/commands/login/get-group.js +5 -6
- package/dist/commands/login/get-group.js.map +1 -1
- package/dist/commands/login/import-configs.d.ts +12 -0
- package/dist/commands/login/import-configs.js +70 -0
- package/dist/commands/login/import-configs.js.map +1 -0
- package/dist/commands/login/import-groups.d.ts +12 -0
- package/dist/commands/login/import-groups.js +51 -0
- package/dist/commands/login/import-groups.js.map +1 -0
- package/dist/commands/login/list-configs.js +1 -2
- package/dist/commands/login/list-configs.js.map +1 -1
- package/dist/commands/login/list-groups.js +1 -2
- package/dist/commands/login/list-groups.js.map +1 -1
- package/dist/commands/login/list-users-in-group.js +5 -6
- package/dist/commands/login/list-users-in-group.js.map +1 -1
- package/dist/commands/login/remove-user-from-group.d.ts +2 -2
- package/dist/commands/login/remove-user-from-group.js +10 -11
- package/dist/commands/login/remove-user-from-group.js.map +1 -1
- package/dist/commands/login/update-config.js +11 -12
- package/dist/commands/login/update-config.js.map +1 -1
- package/dist/commands/project/create-project.js +8 -9
- package/dist/commands/project/create-project.js.map +1 -1
- package/dist/commands/project/get-active-project.js +5 -6
- package/dist/commands/project/get-active-project.js.map +1 -1
- package/dist/commands/project/list-projects.js +2 -3
- package/dist/commands/project/list-projects.js.map +1 -1
- package/dist/commands/project/select-project.js +13 -20
- package/dist/commands/project/select-project.js.map +1 -1
- package/dist/commands/start.d.ts +0 -3
- package/dist/commands/start.js +17 -22
- package/dist/commands/start.js.map +1 -1
- package/dist/commands/stop.js +5 -4
- package/dist/commands/stop.js.map +1 -1
- package/dist/commands/token/create-token.d.ts +2 -2
- package/dist/commands/token/create-token.js +8 -9
- package/dist/commands/token/create-token.js.map +1 -1
- package/dist/commands/token/delete-token.js +5 -6
- package/dist/commands/token/delete-token.js.map +1 -1
- package/dist/commands/token/get-token.d.ts +2 -2
- package/dist/commands/token/get-token.js +5 -6
- package/dist/commands/token/get-token.js.map +1 -1
- package/dist/commands/token/list-tokens.d.ts +2 -2
- package/dist/commands/token/list-tokens.js +3 -4
- package/dist/commands/token/list-tokens.js.map +1 -1
- package/dist/commands/token/update-token.d.ts +2 -2
- package/dist/commands/token/update-token.js +8 -9
- package/dist/commands/token/update-token.js.map +1 -1
- package/dist/commands/whoami.d.ts +1 -4
- package/dist/commands/whoami.js +5 -22
- package/dist/commands/whoami.js.map +1 -1
- package/dist/common/constants.d.ts +5 -11
- package/dist/common/constants.js +7 -15
- package/dist/common/constants.js.map +1 -1
- package/dist/{helpers/generate-error-message.js → common/error-messages.js} +1 -1
- package/dist/common/error-messages.js.map +1 -0
- package/dist/{helpers/prompt-required-flags.js → common/prompts.js} +5 -5
- package/dist/common/prompts.js.map +1 -0
- package/dist/{helpers/input-length-validation.d.ts → common/validators.d.ts} +1 -1
- package/dist/{helpers/input-length-validation.js → common/validators.js} +4 -4
- package/dist/common/validators.js.map +1 -0
- package/dist/helpers/app.d.ts +11 -1
- package/dist/helpers/app.js +84 -10
- package/dist/helpers/app.js.map +1 -1
- package/dist/services/affinidi/auth/auth-result-page.d.ts +1 -0
- package/dist/services/affinidi/auth/{providers/error-login-page.js → auth-result-page.js} +6 -7
- package/dist/services/affinidi/auth/auth-result-page.js.map +1 -0
- package/dist/services/affinidi/auth/bff-auth-provider.d.ts +26 -0
- package/dist/services/affinidi/auth/bff-auth-provider.js +133 -0
- package/dist/services/affinidi/auth/bff-auth-provider.js.map +1 -0
- package/dist/services/affinidi/auth/{providers/types.d.ts → types.d.ts} +1 -4
- package/dist/services/affinidi/auth/types.js.map +1 -0
- package/dist/services/affinidi/bff-service.d.ts +27 -0
- package/dist/services/affinidi/bff-service.js +141 -0
- package/dist/services/affinidi/bff-service.js.map +1 -0
- package/dist/services/affinidi/bff-service.types.d.ts +38 -0
- package/dist/services/affinidi/{config.js → bff-service.types.js} +1 -1
- package/dist/services/affinidi/bff-service.types.js.map +1 -0
- package/dist/services/affinidi/{errors/index.js → errors.js} +6 -3
- package/dist/services/affinidi/errors.js.map +1 -0
- package/dist/services/affinidi/iam/iam.api.d.ts +120 -105
- package/dist/services/affinidi/iam/iam.api.js +39 -118
- package/dist/services/affinidi/iam/iam.api.js.map +1 -1
- package/dist/services/affinidi/iam/index.d.ts +15 -15
- package/dist/services/affinidi/iam/index.js +34 -118
- package/dist/services/affinidi/iam/index.js.map +1 -1
- package/dist/services/affinidi/logger/console-logger-adapter.js.map +1 -0
- package/dist/services/affinidi/logger/index.js.map +1 -0
- package/dist/services/affinidi/logger/logger-adapter.js.map +1 -0
- package/dist/services/affinidi/vp-adapter/index.d.ts +12 -12
- package/dist/services/affinidi/vp-adapter/index.js +37 -70
- package/dist/services/affinidi/vp-adapter/index.js.map +1 -1
- package/dist/services/affinidi/vp-adapter/vp-adapter.api.d.ts +314 -54
- package/dist/services/affinidi/vp-adapter/vp-adapter.api.js +81 -15
- package/dist/services/affinidi/vp-adapter/vp-adapter.api.js.map +1 -1
- package/dist/services/credentials-vault.d.ts +19 -0
- package/dist/services/credentials-vault.js +33 -0
- package/dist/services/credentials-vault.js.map +1 -0
- package/dist/services/env-config.d.ts +35 -0
- package/dist/services/env-config.js +39 -0
- package/dist/services/env-config.js.map +1 -0
- package/package.json +6 -15
- package/dist/helpers/generate-error-message.js.map +0 -1
- package/dist/helpers/index.d.ts +0 -3
- package/dist/helpers/index.js +0 -11
- package/dist/helpers/index.js.map +0 -1
- package/dist/helpers/input-length-validation.js.map +0 -1
- package/dist/helpers/prompt-required-flags.js.map +0 -1
- package/dist/hooks/check/check-version.d.ts +0 -17
- package/dist/hooks/check/check-version.js +0 -24
- package/dist/hooks/check/check-version.js.map +0 -1
- package/dist/services/affinidi/adapters/index.d.ts +0 -1
- package/dist/services/affinidi/adapters/index.js +0 -5
- package/dist/services/affinidi/adapters/index.js.map +0 -1
- package/dist/services/affinidi/adapters/logger/console-logger-adapter.js.map +0 -1
- package/dist/services/affinidi/adapters/logger/index.js.map +0 -1
- package/dist/services/affinidi/adapters/logger/logger-adapter.js.map +0 -1
- package/dist/services/affinidi/auth/index.d.ts +0 -62
- package/dist/services/affinidi/auth/index.js +0 -131
- package/dist/services/affinidi/auth/index.js.map +0 -1
- package/dist/services/affinidi/auth/providers/config.d.ts +0 -15
- package/dist/services/affinidi/auth/providers/config.js +0 -33
- package/dist/services/affinidi/auth/providers/config.js.map +0 -1
- package/dist/services/affinidi/auth/providers/error-login-page.d.ts +0 -1
- package/dist/services/affinidi/auth/providers/error-login-page.js.map +0 -1
- package/dist/services/affinidi/auth/providers/index.d.ts +0 -3
- package/dist/services/affinidi/auth/providers/index.js +0 -8
- package/dist/services/affinidi/auth/providers/index.js.map +0 -1
- package/dist/services/affinidi/auth/providers/ory-pkce.d.ts +0 -47
- package/dist/services/affinidi/auth/providers/ory-pkce.js +0 -216
- package/dist/services/affinidi/auth/providers/ory-pkce.js.map +0 -1
- package/dist/services/affinidi/auth/providers/ory.d.ts +0 -22
- package/dist/services/affinidi/auth/providers/ory.js +0 -154
- package/dist/services/affinidi/auth/providers/ory.js.map +0 -1
- package/dist/services/affinidi/auth/providers/successful-login-page.d.ts +0 -1
- package/dist/services/affinidi/auth/providers/successful-login-page.js +0 -110
- package/dist/services/affinidi/auth/providers/successful-login-page.js.map +0 -1
- package/dist/services/affinidi/auth/providers/types.js.map +0 -1
- package/dist/services/affinidi/auth/token.d.ts +0 -54
- package/dist/services/affinidi/auth/token.js +0 -121
- package/dist/services/affinidi/auth/token.js.map +0 -1
- package/dist/services/affinidi/config.d.ts +0 -12
- package/dist/services/affinidi/config.js.map +0 -1
- package/dist/services/affinidi/errors/index.js.map +0 -1
- package/dist/services/affinidi/index.d.ts +0 -24
- package/dist/services/affinidi/index.js +0 -52
- package/dist/services/affinidi/index.js.map +0 -1
- package/dist/services/config/index.d.ts +0 -36
- package/dist/services/config/index.js +0 -160
- package/dist/services/config/index.js.map +0 -1
- package/dist/services/index.d.ts +0 -1
- package/dist/services/index.js +0 -6
- package/dist/services/index.js.map +0 -1
- package/dist/services/urls.d.ts +0 -2
- package/dist/services/urls.js +0 -12
- package/dist/services/urls.js.map +0 -1
- /package/dist/{helpers/generate-error-message.d.ts → common/error-messages.d.ts} +0 -0
- /package/dist/{helpers/prompt-required-flags.d.ts → common/prompts.d.ts} +0 -0
- /package/dist/services/affinidi/auth/{providers/types.js → types.js} +0 -0
- /package/dist/services/affinidi/{errors/index.d.ts → errors.d.ts} +0 -0
- /package/dist/services/affinidi/{adapters/logger → logger}/console-logger-adapter.d.ts +0 -0
- /package/dist/services/affinidi/{adapters/logger → logger}/console-logger-adapter.js +0 -0
- /package/dist/services/affinidi/{adapters/logger → logger}/index.d.ts +0 -0
- /package/dist/services/affinidi/{adapters/logger → logger}/index.js +0 -0
- /package/dist/services/affinidi/{adapters/logger → logger}/logger-adapter.d.ts +0 -0
- /package/dist/services/affinidi/{adapters/logger → logger}/logger-adapter.js +0 -0
|
@@ -60,7 +60,7 @@ export interface CreateLoginConfigurationOutput {
|
|
|
60
60
|
/** Project id */
|
|
61
61
|
projectId: string;
|
|
62
62
|
/** Configuration id */
|
|
63
|
-
|
|
63
|
+
configurationId?: string;
|
|
64
64
|
/** User defined login configuration name */
|
|
65
65
|
name: string;
|
|
66
66
|
/** OIDC Auth Credentials */
|
|
@@ -119,6 +119,8 @@ export interface LoginSessionDto {
|
|
|
119
119
|
export interface LoginSessionForIDPInput {
|
|
120
120
|
/** IDP Login Challenge to Associate the Session with */
|
|
121
121
|
loginChallenge: string;
|
|
122
|
+
/** IDP client id to Associate the Session with */
|
|
123
|
+
clientId: string;
|
|
122
124
|
}
|
|
123
125
|
export type LoginSessionForIDPOutput = LoginSessionDto;
|
|
124
126
|
/** Authorization Response per OpenID for Verifiable Presentations Specification */
|
|
@@ -141,7 +143,7 @@ export interface LoginConfigurationObject {
|
|
|
141
143
|
/** Configuration ari */
|
|
142
144
|
ari: string;
|
|
143
145
|
/** Configuration id */
|
|
144
|
-
|
|
146
|
+
configurationId?: string;
|
|
145
147
|
/** Project id */
|
|
146
148
|
projectId: string;
|
|
147
149
|
/** User defined login configuration name */
|
|
@@ -162,6 +164,8 @@ export interface LoginConfigurationObject {
|
|
|
162
164
|
idTokenMapping: IdTokenMapping;
|
|
163
165
|
/** login configuration client metadata */
|
|
164
166
|
clientMetadata: LoginConfigurationClientMetadata;
|
|
167
|
+
/** 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. */
|
|
168
|
+
tokenEndpointAuthMethod: TokenEndpointAuthMethod;
|
|
165
169
|
[key: string]: any;
|
|
166
170
|
}
|
|
167
171
|
/**
|
|
@@ -193,29 +197,26 @@ export interface GroupDto {
|
|
|
193
197
|
creationDate: string;
|
|
194
198
|
}
|
|
195
199
|
export interface GroupUserMappingDto {
|
|
196
|
-
/**
|
|
197
|
-
|
|
198
|
-
/** Group user mapping id */
|
|
199
|
-
id: string;
|
|
200
|
-
/** Project id */
|
|
201
|
-
projectId: string;
|
|
202
|
-
/** Group name */
|
|
203
|
-
groupName: string;
|
|
204
|
-
/** Unique identifier of the user, subject of the token */
|
|
205
|
-
sub: string;
|
|
200
|
+
/** Unique identifier of the user */
|
|
201
|
+
userId: string;
|
|
206
202
|
/** Group to user mapping creation date */
|
|
207
|
-
|
|
203
|
+
addedAt: string;
|
|
208
204
|
}
|
|
209
|
-
/** input used to
|
|
205
|
+
/** input used to add a user to a group */
|
|
210
206
|
export interface AddUserToGroupInput {
|
|
211
|
-
/** Unique identifier of the user
|
|
212
|
-
|
|
207
|
+
/** Unique identifier of the user */
|
|
208
|
+
userId: string;
|
|
209
|
+
}
|
|
210
|
+
/** input used to remove a user from a group */
|
|
211
|
+
export interface RemoveUserFromGroupInput {
|
|
212
|
+
/** Unique identifier of the user */
|
|
213
|
+
userId: string;
|
|
213
214
|
}
|
|
214
215
|
export interface GroupsList {
|
|
215
216
|
groups?: GroupDto[];
|
|
216
217
|
}
|
|
217
218
|
export interface GroupUserMappingsList {
|
|
218
|
-
|
|
219
|
+
users?: GroupUserMappingDto[];
|
|
219
220
|
}
|
|
220
221
|
/** login configuration client metadata */
|
|
221
222
|
export interface LoginConfigurationClientMetadata {
|
|
@@ -257,6 +258,219 @@ export interface NotFoundError {
|
|
|
257
258
|
location?: string;
|
|
258
259
|
}[];
|
|
259
260
|
}
|
|
261
|
+
export interface JsonWebKey {
|
|
262
|
+
/** 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. */
|
|
263
|
+
keys?: {
|
|
264
|
+
/** 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. */
|
|
265
|
+
alg: string;
|
|
266
|
+
crv?: string;
|
|
267
|
+
d?: string;
|
|
268
|
+
dp?: string;
|
|
269
|
+
dq?: string;
|
|
270
|
+
e?: string;
|
|
271
|
+
k?: string;
|
|
272
|
+
/** 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. */
|
|
273
|
+
kid: string;
|
|
274
|
+
/** 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. */
|
|
275
|
+
kty: string;
|
|
276
|
+
n?: string;
|
|
277
|
+
p?: string;
|
|
278
|
+
q?: string;
|
|
279
|
+
qi?: string;
|
|
280
|
+
/** 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). */
|
|
281
|
+
use: string;
|
|
282
|
+
x?: string;
|
|
283
|
+
/** 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. */
|
|
284
|
+
x5c: string[];
|
|
285
|
+
y?: string;
|
|
286
|
+
}[];
|
|
287
|
+
}
|
|
288
|
+
export interface OIDCConfig {
|
|
289
|
+
/** OAuth 2.0 Authorization Endpoint URL */
|
|
290
|
+
authorization_endpoint: string;
|
|
291
|
+
/** 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 */
|
|
292
|
+
backchannel_logout_session_supported?: boolean;
|
|
293
|
+
/** OpenID Connect Back-Channel Logout Supported. Boolean value specifying whether the OP supports back-channel logout, with true indicating support. */
|
|
294
|
+
backchannel_logout_supported?: boolean;
|
|
295
|
+
/** OpenID Connect Claims Parameter Parameter Supported Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. */
|
|
296
|
+
claims_parameter_supported?: boolean;
|
|
297
|
+
/** 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. */
|
|
298
|
+
claims_supported?: string[];
|
|
299
|
+
/** 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. */
|
|
300
|
+
code_challenge_methods_supported?: string[];
|
|
301
|
+
/** OpenID Connect Verifiable Credentials Endpoint Contains the URL of the Verifiable Credentials Endpoint. */
|
|
302
|
+
credentials_endpoint_draft_00?: string;
|
|
303
|
+
/** OpenID Connect Verifiable Credentials Supported JSON array containing a list of the Verifiable Credentials supported by this authorization server. */
|
|
304
|
+
credentials_supported_draft_00?: {
|
|
305
|
+
cryptographic_binding_methods_supported?: string[];
|
|
306
|
+
cryptographic_suites_supported?: string[];
|
|
307
|
+
format?: string;
|
|
308
|
+
types?: string[];
|
|
309
|
+
}[];
|
|
310
|
+
/** 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. */
|
|
311
|
+
end_session_endpoint?: string;
|
|
312
|
+
/** 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. */
|
|
313
|
+
frontchannel_logout_session_supported?: boolean;
|
|
314
|
+
/** OpenID Connect Front-Channel Logout Supported Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support. */
|
|
315
|
+
frontchannel_logout_supported?: boolean;
|
|
316
|
+
/** OAuth 2.0 Supported Grant Types JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. */
|
|
317
|
+
grant_types_supported?: string[];
|
|
318
|
+
/**
|
|
319
|
+
* OpenID Connect Default ID Token Signing Algorithms
|
|
320
|
+
* Algorithm used to sign OpenID Connect ID Tokens.
|
|
321
|
+
*/
|
|
322
|
+
id_token_signed_response_alg: string[];
|
|
323
|
+
/**
|
|
324
|
+
* OpenID Connect Supported ID Token Signing Algorithms
|
|
325
|
+
* 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.
|
|
326
|
+
*/
|
|
327
|
+
id_token_signing_alg_values_supported: string[];
|
|
328
|
+
/**
|
|
329
|
+
* OpenID Connect Issuer URL
|
|
330
|
+
* 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.
|
|
331
|
+
*/
|
|
332
|
+
issuer: string;
|
|
333
|
+
/**
|
|
334
|
+
* OpenID Connect Well-Known JSON Web Keys URL
|
|
335
|
+
* 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.
|
|
336
|
+
*/
|
|
337
|
+
jwks_uri: string;
|
|
338
|
+
/** OpenID Connect Dynamic Client Registration Endpoint URL */
|
|
339
|
+
registration_endpoint?: string;
|
|
340
|
+
/**
|
|
341
|
+
* OpenID Connect Supported Request Object Signing Algorithms
|
|
342
|
+
* 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).
|
|
343
|
+
*/
|
|
344
|
+
request_object_signing_alg_values_supported?: string[];
|
|
345
|
+
/**
|
|
346
|
+
* OpenID Connect Request Parameter Supported
|
|
347
|
+
* Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
|
|
348
|
+
*/
|
|
349
|
+
request_parameter_supported?: boolean;
|
|
350
|
+
/**
|
|
351
|
+
* OpenID Connect Request URI Parameter Supported
|
|
352
|
+
* Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
|
|
353
|
+
*/
|
|
354
|
+
request_uri_parameter_supported?: boolean;
|
|
355
|
+
/**
|
|
356
|
+
* OpenID Connect Requires Request URI Registration
|
|
357
|
+
* Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.
|
|
358
|
+
*/
|
|
359
|
+
require_request_uri_registration?: boolean;
|
|
360
|
+
/**
|
|
361
|
+
* OAuth 2.0 Supported Response Modes
|
|
362
|
+
* JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
|
|
363
|
+
*/
|
|
364
|
+
response_modes_supported?: string[];
|
|
365
|
+
/**
|
|
366
|
+
* OAuth 2.0 Supported Response Types
|
|
367
|
+
* 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.
|
|
368
|
+
*/
|
|
369
|
+
response_types_supported: string[];
|
|
370
|
+
/**
|
|
371
|
+
* OAuth 2.0 Token Revocation URL
|
|
372
|
+
* URL of the authorization server's OAuth 2.0 revocation endpoint.
|
|
373
|
+
*/
|
|
374
|
+
revocation_endpoint?: string;
|
|
375
|
+
/**
|
|
376
|
+
* OAuth 2.0 Supported Scope Values
|
|
377
|
+
* 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
|
|
378
|
+
*/
|
|
379
|
+
scopes_supported?: string[];
|
|
380
|
+
/**
|
|
381
|
+
* OpenID Connect Supported Subject Types
|
|
382
|
+
* JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.
|
|
383
|
+
*/
|
|
384
|
+
subject_types_supported: string[];
|
|
385
|
+
/** OAuth 2.0 Token Endpoint URL */
|
|
386
|
+
token_endpoint: string;
|
|
387
|
+
/**
|
|
388
|
+
* OAuth 2.0 Supported Client Authentication Methods
|
|
389
|
+
* 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
|
|
390
|
+
*/
|
|
391
|
+
token_endpoint_auth_methods_supported?: string[];
|
|
392
|
+
/**
|
|
393
|
+
* OpenID Connect Userinfo URL
|
|
394
|
+
* URL of the OP's UserInfo Endpoint.
|
|
395
|
+
*/
|
|
396
|
+
userinfo_endpoint?: string;
|
|
397
|
+
/**
|
|
398
|
+
* OpenID Connect User Userinfo Signing Algorithm
|
|
399
|
+
* Algorithm used to sign OpenID Connect Userinfo Responses.
|
|
400
|
+
*/
|
|
401
|
+
userinfo_signed_response_alg: string[];
|
|
402
|
+
/**
|
|
403
|
+
* OpenID Connect Supported Userinfo Signing Algorithm
|
|
404
|
+
* 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].
|
|
405
|
+
*/
|
|
406
|
+
userinfo_signing_alg_values_supported?: string[];
|
|
407
|
+
}
|
|
408
|
+
export interface OAuth2Token {
|
|
409
|
+
/** The access token issued by the authorization server. */
|
|
410
|
+
access_token?: string;
|
|
411
|
+
/** 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. */
|
|
412
|
+
expires_in?: number;
|
|
413
|
+
/** To retrieve a refresh token request the id_token scope. */
|
|
414
|
+
id_token?: number;
|
|
415
|
+
/** The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope "offline" to your access token request. */
|
|
416
|
+
refresh_token?: string;
|
|
417
|
+
/** The scope of the access token */
|
|
418
|
+
scope?: string;
|
|
419
|
+
/** The type of the token issued */
|
|
420
|
+
token_type?: string;
|
|
421
|
+
}
|
|
422
|
+
export interface GetUserInfo {
|
|
423
|
+
/** 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. */
|
|
424
|
+
birthdate?: string;
|
|
425
|
+
/** 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. */
|
|
426
|
+
email?: string;
|
|
427
|
+
/** 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. */
|
|
428
|
+
email_verified?: boolean;
|
|
429
|
+
/** 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. */
|
|
430
|
+
family_name?: string;
|
|
431
|
+
/** 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. */
|
|
432
|
+
gender?: string;
|
|
433
|
+
/** 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. */
|
|
434
|
+
given_name?: string;
|
|
435
|
+
/** 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. */
|
|
436
|
+
locale?: string;
|
|
437
|
+
/** 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. */
|
|
438
|
+
middle_name?: string;
|
|
439
|
+
/** 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. */
|
|
440
|
+
name?: string;
|
|
441
|
+
/** 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. */
|
|
442
|
+
nickname?: string;
|
|
443
|
+
/** 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. */
|
|
444
|
+
phone_number?: string;
|
|
445
|
+
/** 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. */
|
|
446
|
+
phone_number_verified?: boolean;
|
|
447
|
+
/** 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. */
|
|
448
|
+
picture?: string;
|
|
449
|
+
/** 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. */
|
|
450
|
+
preferred_username?: string;
|
|
451
|
+
/** URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. */
|
|
452
|
+
profile?: string;
|
|
453
|
+
/** Subject - Identifier for the End-User at the IssuerURL. */
|
|
454
|
+
sub?: string;
|
|
455
|
+
/** 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. */
|
|
456
|
+
updated_at?: number;
|
|
457
|
+
/** 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. */
|
|
458
|
+
website?: string;
|
|
459
|
+
/** String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. */
|
|
460
|
+
zoneinfo?: string;
|
|
461
|
+
}
|
|
462
|
+
export interface ErrorOAuth2 {
|
|
463
|
+
/** Error */
|
|
464
|
+
error: string;
|
|
465
|
+
/** Error Debug Information. Only available in dev mode. */
|
|
466
|
+
error_debug?: string;
|
|
467
|
+
/** Error Description */
|
|
468
|
+
error_description: string;
|
|
469
|
+
/** Error Hint. Helps the user identify the error cause. */
|
|
470
|
+
error_hint?: string;
|
|
471
|
+
/** HTTP Status Code */
|
|
472
|
+
status_code: string;
|
|
473
|
+
}
|
|
260
474
|
export interface ResourceCreationError {
|
|
261
475
|
name: 'ResourceCreationError';
|
|
262
476
|
message: 'Failed to create resources.';
|
|
@@ -305,7 +519,7 @@ export interface VPTokenValidationError {
|
|
|
305
519
|
location?: string;
|
|
306
520
|
}[];
|
|
307
521
|
}
|
|
308
|
-
import
|
|
522
|
+
import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
|
|
309
523
|
export type QueryParamsType = Record<string | number, any>;
|
|
310
524
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
311
525
|
/** set parameter to `true` for call `securityWorker` for this request */
|
|
@@ -344,7 +558,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
344
558
|
protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
|
|
345
559
|
protected stringifyFormItem(formItem: unknown): string;
|
|
346
560
|
protected createFormData(input: Record<string, unknown>): FormData;
|
|
347
|
-
request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<
|
|
561
|
+
request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T, any>>;
|
|
348
562
|
}
|
|
349
563
|
/**
|
|
350
564
|
* @title OidcVpAdapterBackend
|
|
@@ -369,7 +583,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
369
583
|
consentRequest: (query?: {
|
|
370
584
|
/** Consent challenge provided by IDP */
|
|
371
585
|
consent_challenge?: string;
|
|
372
|
-
}, params?: RequestParams) => Promise<
|
|
586
|
+
}, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
373
587
|
/**
|
|
374
588
|
* @description Creates Login Session for IDP Login by using the Login Challenge
|
|
375
589
|
*
|
|
@@ -378,7 +592,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
378
592
|
* @summary Create Login Session for IDP Login
|
|
379
593
|
* @request POST:/v1/login/sessions/for-idp
|
|
380
594
|
*/
|
|
381
|
-
loginSessionForIdp: (data: LoginSessionForIDPInput, params?: RequestParams) => Promise<
|
|
595
|
+
loginSessionForIdp: (data: LoginSessionForIDPInput, params?: RequestParams) => Promise<AxiosResponse<LoginSessionDto, any>>;
|
|
382
596
|
/**
|
|
383
597
|
* @description Enable CORS by returning correct headers
|
|
384
598
|
*
|
|
@@ -387,7 +601,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
387
601
|
* @summary CORS Support
|
|
388
602
|
* @request OPTIONS:/v1/login/sessions/for-idp
|
|
389
603
|
*/
|
|
390
|
-
corsLoginSessionForIdp: (params?: RequestParams) => Promise<
|
|
604
|
+
corsLoginSessionForIdp: (params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
391
605
|
/**
|
|
392
606
|
* @description Accepts and Validates the OIDC VP Response sent by the Wallet
|
|
393
607
|
*
|
|
@@ -396,7 +610,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
396
610
|
* @summary Accept OIDC VP Response for Login Session
|
|
397
611
|
* @request POST:/v1/login/sessions/{sessionId}/accept-response
|
|
398
612
|
*/
|
|
399
|
-
loginSessionAcceptResponse: (sessionId: string, data: LoginSessionAcceptResponseInput, params?: RequestParams) => Promise<
|
|
613
|
+
loginSessionAcceptResponse: (sessionId: string, data: LoginSessionAcceptResponseInput, params?: RequestParams) => Promise<AxiosResponse<LoginSessionAcceptResponseOutput, any>>;
|
|
400
614
|
/**
|
|
401
615
|
* @description Enable CORS by returning correct headers
|
|
402
616
|
*
|
|
@@ -405,7 +619,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
405
619
|
* @summary CORS Support
|
|
406
620
|
* @request OPTIONS:/v1/login/sessions/{sessionId}/accept-response
|
|
407
621
|
*/
|
|
408
|
-
corsLoginSessionAcceptResponse: (sessionId: string, params?: RequestParams) => Promise<
|
|
622
|
+
corsLoginSessionAcceptResponse: (sessionId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
409
623
|
/**
|
|
410
624
|
* @description The user declines the request for access to their data
|
|
411
625
|
*
|
|
@@ -414,7 +628,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
414
628
|
* @summary Reject Response for Login Session
|
|
415
629
|
* @request POST:/v1/login/sessions/{sessionId}/reject-response
|
|
416
630
|
*/
|
|
417
|
-
loginSessionRejectResponse: (sessionId: string, data: LoginSessionRejectResponseInput, params?: RequestParams) => Promise<
|
|
631
|
+
loginSessionRejectResponse: (sessionId: string, data: LoginSessionRejectResponseInput, params?: RequestParams) => Promise<AxiosResponse<LoginSessionRejectResponseOutput, any>>;
|
|
418
632
|
/**
|
|
419
633
|
* @description Enable CORS by returning correct headers
|
|
420
634
|
*
|
|
@@ -423,7 +637,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
423
637
|
* @summary CORS Support
|
|
424
638
|
* @request OPTIONS:/v1/login/sessions/{sessionId}/reject-response
|
|
425
639
|
*/
|
|
426
|
-
corsLoginSessionRejectResponse: (sessionId: string, params?: RequestParams) => Promise<
|
|
640
|
+
corsLoginSessionRejectResponse: (sessionId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
427
641
|
/**
|
|
428
642
|
* @description Endpoint to retrieve list of login configurations
|
|
429
643
|
*
|
|
@@ -433,7 +647,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
433
647
|
* @request GET:/v1/login/configurations
|
|
434
648
|
* @secure
|
|
435
649
|
*/
|
|
436
|
-
listLoginConfigurations: (params?: RequestParams) => Promise<
|
|
650
|
+
listLoginConfigurations: (params?: RequestParams) => Promise<AxiosResponse<ListLoginConfigurationOutput, any>>;
|
|
437
651
|
/**
|
|
438
652
|
* @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.
|
|
439
653
|
*
|
|
@@ -443,7 +657,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
443
657
|
* @request POST:/v1/login/configurations
|
|
444
658
|
* @secure
|
|
445
659
|
*/
|
|
446
|
-
createLoginConfigurations: (data: CreateLoginConfigurationInput, params?: RequestParams) => Promise<
|
|
660
|
+
createLoginConfigurations: (data: CreateLoginConfigurationInput, params?: RequestParams) => Promise<AxiosResponse<CreateLoginConfigurationOutput, any>>;
|
|
447
661
|
/**
|
|
448
662
|
* @description Get login configuration by ID
|
|
449
663
|
*
|
|
@@ -453,7 +667,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
453
667
|
* @request GET:/v1/login/configurations/{configurationId}
|
|
454
668
|
* @secure
|
|
455
669
|
*/
|
|
456
|
-
getLoginConfigurationsById: (configurationId: string, params?: RequestParams) => Promise<
|
|
670
|
+
getLoginConfigurationsById: (configurationId: string, params?: RequestParams) => Promise<AxiosResponse<LoginConfigurationObject, any>>;
|
|
457
671
|
/**
|
|
458
672
|
* @description Update login configurations by ID
|
|
459
673
|
*
|
|
@@ -463,7 +677,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
463
677
|
* @request PATCH:/v1/login/configurations/{configurationId}
|
|
464
678
|
* @secure
|
|
465
679
|
*/
|
|
466
|
-
updateLoginConfigurationsById: (configurationId: string, data: UpdateLoginConfigurationInput, params?: RequestParams) => Promise<
|
|
680
|
+
updateLoginConfigurationsById: (configurationId: string, data: UpdateLoginConfigurationInput, params?: RequestParams) => Promise<AxiosResponse<LoginConfigurationObject, any>>;
|
|
467
681
|
/**
|
|
468
682
|
* @description Delete login configurations by ID
|
|
469
683
|
*
|
|
@@ -473,7 +687,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
473
687
|
* @request DELETE:/v1/login/configurations/{configurationId}
|
|
474
688
|
* @secure
|
|
475
689
|
*/
|
|
476
|
-
deleteLoginConfigurationsById: (configurationId: string, params?: RequestParams) => Promise<
|
|
690
|
+
deleteLoginConfigurationsById: (configurationId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
477
691
|
/**
|
|
478
692
|
* @description Get Client Metadata By OAuth 2.0 Client ID
|
|
479
693
|
*
|
|
@@ -481,9 +695,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
481
695
|
* @name GetClientMetadataByClientId
|
|
482
696
|
* @summary Get Client Metadata By OAuth 2.0 Client ID
|
|
483
697
|
* @request GET:/v1/login/configurations/metadata/{clientId}
|
|
484
|
-
* @secure
|
|
485
698
|
*/
|
|
486
|
-
getClientMetadataByClientId: (clientId: string, params?: RequestParams) => Promise<
|
|
699
|
+
getClientMetadataByClientId: (clientId: string, params?: RequestParams) => Promise<AxiosResponse<LoginConfigurationClientMetadata, any>>;
|
|
487
700
|
/**
|
|
488
701
|
* No description
|
|
489
702
|
*
|
|
@@ -492,7 +705,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
492
705
|
* @request GET:/v1/groups
|
|
493
706
|
* @secure
|
|
494
707
|
*/
|
|
495
|
-
listGroups: (params?: RequestParams) => Promise<
|
|
708
|
+
listGroups: (params?: RequestParams) => Promise<AxiosResponse<GroupsList, any>>;
|
|
496
709
|
/**
|
|
497
710
|
* No description
|
|
498
711
|
*
|
|
@@ -501,7 +714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
501
714
|
* @request POST:/v1/groups
|
|
502
715
|
* @secure
|
|
503
716
|
*/
|
|
504
|
-
createGroup: (data: CreateGroupInput, params?: RequestParams) => Promise<
|
|
717
|
+
createGroup: (data: CreateGroupInput, params?: RequestParams) => Promise<AxiosResponse<GroupDto, any>>;
|
|
505
718
|
/**
|
|
506
719
|
* No description
|
|
507
720
|
*
|
|
@@ -510,7 +723,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
510
723
|
* @request GET:/v1/groups/{groupName}
|
|
511
724
|
* @secure
|
|
512
725
|
*/
|
|
513
|
-
getGroupById: (groupName: string, params?: RequestParams) => Promise<
|
|
726
|
+
getGroupById: (groupName: string, params?: RequestParams) => Promise<AxiosResponse<GroupDto, any>>;
|
|
514
727
|
/**
|
|
515
728
|
* No description
|
|
516
729
|
*
|
|
@@ -519,7 +732,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
519
732
|
* @request DELETE:/v1/groups/{groupName}
|
|
520
733
|
* @secure
|
|
521
734
|
*/
|
|
522
|
-
deleteGroup: (groupName: string, params?: RequestParams) => Promise<
|
|
735
|
+
deleteGroup: (groupName: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
523
736
|
/**
|
|
524
737
|
* No description
|
|
525
738
|
*
|
|
@@ -528,7 +741,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
528
741
|
* @request GET:/v1/groups/{groupName}/users
|
|
529
742
|
* @secure
|
|
530
743
|
*/
|
|
531
|
-
listGroupUserMappings: (groupName: string, params?: RequestParams) => Promise<
|
|
744
|
+
listGroupUserMappings: (groupName: string, params?: RequestParams) => Promise<AxiosResponse<GroupUserMappingsList, any>>;
|
|
532
745
|
/**
|
|
533
746
|
* No description
|
|
534
747
|
*
|
|
@@ -537,66 +750,113 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
537
750
|
* @request POST:/v1/groups/{groupName}/users
|
|
538
751
|
* @secure
|
|
539
752
|
*/
|
|
540
|
-
addUserToGroup: (groupName: string, data: AddUserToGroupInput, params?: RequestParams) => Promise<
|
|
753
|
+
addUserToGroup: (groupName: string, data: AddUserToGroupInput, params?: RequestParams) => Promise<AxiosResponse<GroupUserMappingDto, any>>;
|
|
541
754
|
/**
|
|
542
755
|
* No description
|
|
543
756
|
*
|
|
544
757
|
* @tags group
|
|
545
758
|
* @name RemoveUserFromGroup
|
|
546
|
-
* @request DELETE:/v1/groups/{groupName}/users
|
|
759
|
+
* @request DELETE:/v1/groups/{groupName}/users
|
|
547
760
|
* @secure
|
|
548
761
|
*/
|
|
549
|
-
removeUserFromGroup: (groupName: string,
|
|
762
|
+
removeUserFromGroup: (groupName: string, data: RemoveUserFromGroupInput, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
550
763
|
/**
|
|
551
764
|
* No description
|
|
552
765
|
*
|
|
553
766
|
* @name LoginAdminProxyList
|
|
554
767
|
* @request GET:/v1/login/admin/{proxy+}
|
|
555
768
|
*/
|
|
556
|
-
loginAdminProxyList: (proxy: string, params?: RequestParams) => Promise<
|
|
769
|
+
loginAdminProxyList: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
557
770
|
/**
|
|
558
771
|
* No description
|
|
559
772
|
*
|
|
560
773
|
* @name LoginAdminProxyCreate
|
|
561
774
|
* @request POST:/v1/login/admin/{proxy+}
|
|
562
775
|
*/
|
|
563
|
-
loginAdminProxyCreate: (proxy: string, params?: RequestParams) => Promise<
|
|
776
|
+
loginAdminProxyCreate: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
564
777
|
/**
|
|
565
778
|
* No description
|
|
566
779
|
*
|
|
567
780
|
* @name LoginAdminProxyDelete
|
|
568
781
|
* @request DELETE:/v1/login/admin/{proxy+}
|
|
569
782
|
*/
|
|
570
|
-
loginAdminProxyDelete: (proxy: string, params?: RequestParams) => Promise<
|
|
783
|
+
loginAdminProxyDelete: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
571
784
|
/**
|
|
572
785
|
* No description
|
|
573
786
|
*
|
|
574
787
|
* @name LoginAdminProxyUpdate
|
|
575
788
|
* @request PUT:/v1/login/admin/{proxy+}
|
|
576
789
|
*/
|
|
577
|
-
loginAdminProxyUpdate: (proxy: string, params?: RequestParams) => Promise<
|
|
790
|
+
loginAdminProxyUpdate: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
578
791
|
/**
|
|
579
792
|
* No description
|
|
580
793
|
*
|
|
581
794
|
* @name LoginAdminProxyPartialUpdate
|
|
582
795
|
* @request PATCH:/v1/login/admin/{proxy+}
|
|
583
796
|
*/
|
|
584
|
-
loginAdminProxyPartialUpdate: (proxy: string, params?: RequestParams) => Promise<
|
|
797
|
+
loginAdminProxyPartialUpdate: (proxy: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
585
798
|
/**
|
|
586
|
-
*
|
|
799
|
+
* @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.
|
|
587
800
|
*
|
|
588
801
|
* @tags idp
|
|
589
|
-
* @name
|
|
590
|
-
* @
|
|
802
|
+
* @name LoginProjectWellKnownJwksJsonDetail
|
|
803
|
+
* @summary Discover Well-Known JSON Web Keys
|
|
804
|
+
* @request GET:/v1/login/project/{projectId}/.well-known/jwks.json
|
|
591
805
|
*/
|
|
592
|
-
|
|
806
|
+
loginProjectWellKnownJwksJsonDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<JsonWebKey, any>>;
|
|
593
807
|
/**
|
|
594
|
-
*
|
|
808
|
+
* @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.
|
|
809
|
+
*
|
|
810
|
+
* @tags idp
|
|
811
|
+
* @name LoginProjectWellKnownOpenidConfigurationDetail
|
|
812
|
+
* @summary OpenID Connect Discovery
|
|
813
|
+
* @request GET:/v1/login/project/{projectId}/.well-known/openid-configuration
|
|
814
|
+
*/
|
|
815
|
+
loginProjectWellKnownOpenidConfigurationDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<OIDCConfig, any>>;
|
|
816
|
+
/**
|
|
817
|
+
* @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.
|
|
818
|
+
*
|
|
819
|
+
* @tags idp
|
|
820
|
+
* @name LoginProjectOauth2AuthDetail
|
|
821
|
+
* @summary OAuth 2.0 Authorize Endpoint
|
|
822
|
+
* @request GET:/v1/login/project/{projectId}/oauth2/auth
|
|
823
|
+
*/
|
|
824
|
+
loginProjectOauth2AuthDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
|
|
825
|
+
/**
|
|
826
|
+
* @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.
|
|
827
|
+
*
|
|
828
|
+
* @tags idp
|
|
829
|
+
* @name LoginProjectOauth2RevokeCreate
|
|
830
|
+
* @summary Revoke OAuth 2.0 Access or Refresh Token
|
|
831
|
+
* @request POST:/v1/login/project/{projectId}/oauth2/revoke
|
|
832
|
+
*/
|
|
833
|
+
loginProjectOauth2RevokeCreate: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
834
|
+
/**
|
|
835
|
+
* @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.
|
|
836
|
+
*
|
|
837
|
+
* @tags idp
|
|
838
|
+
* @name LoginProjectOauth2SessionsLogoutDetail
|
|
839
|
+
* @summary OpenID Connect Front- and Back-channel Enabled Logout
|
|
840
|
+
* @request GET:/v1/login/project/{projectId}/oauth2/sessions/logout
|
|
841
|
+
*/
|
|
842
|
+
loginProjectOauth2SessionsLogoutDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
843
|
+
/**
|
|
844
|
+
* @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.
|
|
845
|
+
*
|
|
846
|
+
* @tags idp
|
|
847
|
+
* @name LoginProjectOauth2TokenCreate
|
|
848
|
+
* @summary The OAuth 2.0 Token Endpoint
|
|
849
|
+
* @request POST:/v1/login/project/{projectId}/oauth2/token
|
|
850
|
+
*/
|
|
851
|
+
loginProjectOauth2TokenCreate: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<OAuth2Token, any>>;
|
|
852
|
+
/**
|
|
853
|
+
* @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.
|
|
595
854
|
*
|
|
596
855
|
* @tags idp
|
|
597
|
-
* @name
|
|
598
|
-
* @
|
|
856
|
+
* @name LoginProjectUserinfoDetail
|
|
857
|
+
* @summary OpenID Connect Userinfo
|
|
858
|
+
* @request GET:/v1/login/project/{projectId}/userinfo
|
|
599
859
|
*/
|
|
600
|
-
|
|
860
|
+
loginProjectUserinfoDetail: (projectId: string, params?: RequestParams) => Promise<AxiosResponse<GetUserInfo, any>>;
|
|
601
861
|
};
|
|
602
862
|
}
|