@mittwald/api-client 4.510.0 → 4.512.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.
@@ -1970,6 +1970,38 @@ export declare namespace MittwaldAPIV3Next {
1970
1970
  type RequestData = InferredRequestData<typeof descriptors.verificationVerifyCompany>;
1971
1971
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.verificationVerifyCompany, TStatus>;
1972
1972
  }
1973
+ namespace UserAuthenticatePasskey {
1974
+ type RequestData = InferredRequestData<typeof descriptors.userAuthenticatePasskey>;
1975
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userAuthenticatePasskey, TStatus>;
1976
+ }
1977
+ namespace UserCreatePasskeyChallenge {
1978
+ type RequestData = InferredRequestData<typeof descriptors.userCreatePasskeyChallenge>;
1979
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userCreatePasskeyChallenge, TStatus>;
1980
+ }
1981
+ namespace UserDeletePasskey {
1982
+ type RequestData = InferredRequestData<typeof descriptors.userDeletePasskey>;
1983
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userDeletePasskey, TStatus>;
1984
+ }
1985
+ namespace UserUpdatePasskey {
1986
+ type RequestData = InferredRequestData<typeof descriptors.userUpdatePasskey>;
1987
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userUpdatePasskey, TStatus>;
1988
+ }
1989
+ namespace UserListPasskeys {
1990
+ type RequestData = InferredRequestData<typeof descriptors.userListPasskeys>;
1991
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userListPasskeys, TStatus>;
1992
+ }
1993
+ namespace UserCreatePasskey {
1994
+ type RequestData = InferredRequestData<typeof descriptors.userCreatePasskey>;
1995
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userCreatePasskey, TStatus>;
1996
+ }
1997
+ namespace UserCreatePasskeyConfirmationChallenge {
1998
+ type RequestData = InferredRequestData<typeof descriptors.userCreatePasskeyConfirmationChallenge>;
1999
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userCreatePasskeyConfirmationChallenge, TStatus>;
2000
+ }
2001
+ namespace UserCreatePasskeyRegistrationChallenge {
2002
+ type RequestData = InferredRequestData<typeof descriptors.userCreatePasskeyRegistrationChallenge>;
2003
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.userCreatePasskeyRegistrationChallenge, TStatus>;
2004
+ }
1973
2005
  }
1974
2006
  namespace Components {
1975
2007
  namespace Schemas {
@@ -8863,6 +8895,314 @@ export declare namespace MittwaldAPIV3Next {
8863
8895
  }
8864
8896
  type DeMittwaldVerificationEmailOrigin = "IS_MITTWALD" | "IS_NOT_MITTWALD" | "COULD_BE_MITTWALD";
8865
8897
  type DeMittwaldContainerVolumeSortOrder = "nameAsc" | "nameDesc" | "storageAsc" | "storageDesc";
8898
+ /**
8899
+ * A passkey assertion: the result of `navigator.credentials.get()` serialized with
8900
+ * [`credential.toJSON()`](https://www.w3.org/TR/webauthn-3/#dom-publickeycredential-tojson), as WebAuthn Level 3
8901
+ * [`AuthenticationResponseJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-authenticationresponsejson). Send it
8902
+ * unchanged. Binary values are base64url-encoded without padding.
8903
+ *
8904
+ */
8905
+ interface DeMittwaldSignupPasskeyAuthenticationResponse {
8906
+ /**
8907
+ * `platform` or `cross-platform`, if the browser reports it.
8908
+ */
8909
+ authenticatorAttachment?: string;
8910
+ /**
8911
+ * WebAuthn Level 3
8912
+ * [`AuthenticationExtensionsClientOutputsJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-authenticationextensionsclientoutputsjson).
8913
+ *
8914
+ */
8915
+ clientExtensionResults: {};
8916
+ /**
8917
+ * The credential id, base64url-encoded without padding.
8918
+ */
8919
+ id: string;
8920
+ /**
8921
+ * The credential id, base64url-encoded without padding (same value as `id`).
8922
+ */
8923
+ rawId: string;
8924
+ /**
8925
+ * WebAuthn Level 3
8926
+ * [`AuthenticatorAssertionResponseJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-authenticatorassertionresponsejson).
8927
+ *
8928
+ */
8929
+ response: {
8930
+ /**
8931
+ * The authenticator data, base64url-encoded without padding.
8932
+ */
8933
+ authenticatorData: string;
8934
+ /**
8935
+ * The client data (type, challenge, origin) as JSON, base64url-encoded without padding.
8936
+ */
8937
+ clientDataJSON: string;
8938
+ /**
8939
+ * The assertion signature, base64url-encoded without padding.
8940
+ */
8941
+ signature: string;
8942
+ /**
8943
+ * The `user.id` of the registration, base64url-encoded without padding. The passkey login
8944
+ * (`POST /authenticate-passkey`) takes the user from it.
8945
+ *
8946
+ */
8947
+ userHandle?: string;
8948
+ };
8949
+ /**
8950
+ * The credential type, always `public-key`.
8951
+ */
8952
+ type: string;
8953
+ }
8954
+ /**
8955
+ * A challenge for signing in or confirming an action with a passkey. Run `navigator.credentials.get()` with
8956
+ * `options` and send `challengeId` together with the resulting `credential.toJSON()`. The challenge can be used
8957
+ * once.
8958
+ *
8959
+ */
8960
+ interface DeMittwaldSignupPasskeyChallenge {
8961
+ challengeId: string;
8962
+ options: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyRequestOptions;
8963
+ }
8964
+ /**
8965
+ * Options for registering a passkey, as WebAuthn Level 3
8966
+ * [`PublicKeyCredentialCreationOptionsJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialcreationoptionsjson).
8967
+ * Pass the object unchanged to
8968
+ * [`PublicKeyCredential.parseCreationOptionsFromJSON()`](https://www.w3.org/TR/webauthn-3/#sctn-parseCreationOptionsFromJSON)
8969
+ * and the result as `publicKey` to `navigator.credentials.create()`. Send the resulting credential back as
8970
+ * [`credential.toJSON()`](https://www.w3.org/TR/webauthn-3/#dom-publickeycredential-tojson) together with the
8971
+ * `challengeId` the options came with. Binary values are base64url-encoded without padding.
8972
+ *
8973
+ */
8974
+ interface DeMittwaldSignupPasskeyCreationOptions {
8975
+ /**
8976
+ * Always `none`; the API does not check which authenticator model created the passkey.
8977
+ */
8978
+ attestation: string;
8979
+ /**
8980
+ * Not set by this API.
8981
+ */
8982
+ attestationFormats?: string[];
8983
+ /**
8984
+ * Always a discoverable credential (`residentKey: required`) with user verification
8985
+ * (`userVerification: required`); no `authenticatorAttachment`, so the browser also offers other devices
8986
+ * (QR code).
8987
+ *
8988
+ */
8989
+ authenticatorSelection: {
8990
+ authenticatorAttachment?: string;
8991
+ requireResidentKey?: boolean;
8992
+ residentKey?: string;
8993
+ userVerification?: string;
8994
+ };
8995
+ /**
8996
+ * 32 random bytes, base64url-encoded without padding. Can be used once.
8997
+ */
8998
+ challenge: string;
8999
+ /**
9000
+ * The passkeys the user already has for this relying party; the authenticator does not register them again.
9001
+ */
9002
+ excludeCredentials: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredentialDescriptor[];
9003
+ /**
9004
+ * WebAuthn Level 3
9005
+ * [`AuthenticationExtensionsClientInputsJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-authenticationextensionsclientinputsjson).
9006
+ *
9007
+ */
9008
+ extensions?: {};
9009
+ /**
9010
+ * Hints for the browser which authenticator to offer. Not set by this API.
9011
+ */
9012
+ hints?: string[];
9013
+ /**
9014
+ * The accepted key types, ES256 (`-7`) and RS256 (`-257`).
9015
+ */
9016
+ pubKeyCredParams: {
9017
+ /**
9018
+ * A COSE algorithm identifier.
9019
+ */
9020
+ alg: number;
9021
+ /**
9022
+ * Always `public-key`.
9023
+ */
9024
+ type: string;
9025
+ }[];
9026
+ /**
9027
+ * The relying party, selected from the `Origin` header of the request that created the challenge.
9028
+ */
9029
+ rp: {
9030
+ id: string;
9031
+ name: string;
9032
+ };
9033
+ /**
9034
+ * Milliseconds until the challenge expires.
9035
+ */
9036
+ timeout: number;
9037
+ /**
9038
+ * The user the passkey is created for, as WebAuthn Level 3
9039
+ * [`PublicKeyCredentialUserEntityJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialuserentityjson).
9040
+ *
9041
+ */
9042
+ user: {
9043
+ /**
9044
+ * First and last name of the user, or the email address if both are empty.
9045
+ */
9046
+ displayName: string;
9047
+ /**
9048
+ * The UTF-8 bytes of the user id, base64url-encoded without padding. A passkey login returns it as
9049
+ * `response.userHandle`.
9050
+ *
9051
+ */
9052
+ id: string;
9053
+ /**
9054
+ * The verified email address of the user.
9055
+ */
9056
+ name: string;
9057
+ };
9058
+ }
9059
+ /**
9060
+ * A passkey of the user, as WebAuthn Level 3
9061
+ * [`PublicKeyCredentialDescriptorJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialdescriptorjson).
9062
+ *
9063
+ */
9064
+ interface DeMittwaldSignupPasskeyCredentialDescriptor {
9065
+ /**
9066
+ * The credential id, base64url-encoded without padding.
9067
+ */
9068
+ id: string;
9069
+ /**
9070
+ * How the browser can reach the authenticator, as reported at registration (`internal`, `hybrid`, `usb`,
9071
+ * `nfc`, `ble`, `smart-card`).
9072
+ *
9073
+ */
9074
+ transports?: string[];
9075
+ /**
9076
+ * The credential type, always `public-key`.
9077
+ */
9078
+ type: string;
9079
+ }
9080
+ /**
9081
+ * A passkey assertion that proves the second factor. `challengeId` comes from `POST /users/self/passkey-challenges`
9082
+ * (or from `passkeyChallenge` of `POST /authenticate` for `POST /authenticate-mfa`), `credential` is the
9083
+ * `credential.toJSON()` of the `navigator.credentials.get()` call with its `options`.
9084
+ *
9085
+ */
9086
+ interface DeMittwaldSignupPasskeyCredential {
9087
+ challengeId: string;
9088
+ credential: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyAuthenticationResponse;
9089
+ }
9090
+ /**
9091
+ * A challenge for registering a passkey. Run `navigator.credentials.create()` with `options` and send
9092
+ * `challengeId` together with the resulting `credential.toJSON()` to `POST /users/self/passkeys`. The challenge
9093
+ * can be used once.
9094
+ *
9095
+ */
9096
+ interface DeMittwaldSignupPasskeyRegistrationChallenge {
9097
+ challengeId: string;
9098
+ options: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCreationOptions;
9099
+ }
9100
+ /**
9101
+ * A new passkey: the result of `navigator.credentials.create()` serialized with
9102
+ * [`credential.toJSON()`](https://www.w3.org/TR/webauthn-3/#dom-publickeycredential-tojson), as WebAuthn Level 3
9103
+ * [`RegistrationResponseJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-registrationresponsejson). Send it
9104
+ * unchanged. Binary values are base64url-encoded without padding.
9105
+ *
9106
+ */
9107
+ interface DeMittwaldSignupPasskeyRegistrationResponse {
9108
+ /**
9109
+ * `platform` or `cross-platform`, if the browser reports it.
9110
+ */
9111
+ authenticatorAttachment?: string;
9112
+ /**
9113
+ * WebAuthn Level 3
9114
+ * [`AuthenticationExtensionsClientOutputsJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-authenticationextensionsclientoutputsjson).
9115
+ *
9116
+ */
9117
+ clientExtensionResults: {};
9118
+ /**
9119
+ * The credential id, base64url-encoded without padding.
9120
+ */
9121
+ id: string;
9122
+ /**
9123
+ * The credential id, base64url-encoded without padding (same value as `id`).
9124
+ */
9125
+ rawId: string;
9126
+ /**
9127
+ * WebAuthn Level 3
9128
+ * [`AuthenticatorAttestationResponseJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-authenticatorattestationresponsejson).
9129
+ *
9130
+ */
9131
+ response: {
9132
+ /**
9133
+ * The CBOR attestation object, base64url-encoded without padding.
9134
+ */
9135
+ attestationObject: string;
9136
+ /**
9137
+ * The authenticator data, base64url-encoded without padding.
9138
+ */
9139
+ authenticatorData: string;
9140
+ /**
9141
+ * The client data (type, challenge, origin) as JSON, base64url-encoded without padding.
9142
+ */
9143
+ clientDataJSON: string;
9144
+ /**
9145
+ * The public key as DER `SubjectPublicKeyInfo`, base64url-encoded without padding, if the browser knows the algorithm.
9146
+ */
9147
+ publicKey?: string;
9148
+ /**
9149
+ * The COSE algorithm identifier of the key.
9150
+ */
9151
+ publicKeyAlgorithm: number;
9152
+ /**
9153
+ * How the browser can reach the authenticator (`internal`, `hybrid`, `usb`, `nfc`, `ble`, `smart-card`).
9154
+ */
9155
+ transports: string[];
9156
+ };
9157
+ /**
9158
+ * The credential type, always `public-key`.
9159
+ */
9160
+ type: string;
9161
+ }
9162
+ /**
9163
+ * Options for signing in with a passkey, as WebAuthn Level 3
9164
+ * [`PublicKeyCredentialRequestOptionsJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialrequestoptionsjson).
9165
+ * Pass the object unchanged to
9166
+ * [`PublicKeyCredential.parseRequestOptionsFromJSON()`](https://www.w3.org/TR/webauthn-3/#sctn-parseRequestOptionsFromJSON)
9167
+ * and the result as `publicKey` to `navigator.credentials.get()`. Send the resulting credential back as
9168
+ * [`credential.toJSON()`](https://www.w3.org/TR/webauthn-3/#dom-publickeycredential-tojson) together with the
9169
+ * `challengeId` the options came with. Binary values are base64url-encoded without padding.
9170
+ *
9171
+ */
9172
+ interface DeMittwaldSignupPasskeyRequestOptions {
9173
+ /**
9174
+ * The passkeys of the user for this relying party. Empty for the passkey login, so the browser offers every
9175
+ * passkey it has for the relying party.
9176
+ *
9177
+ */
9178
+ allowCredentials: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredentialDescriptor[];
9179
+ /**
9180
+ * 32 random bytes, base64url-encoded without padding. Can be used once.
9181
+ */
9182
+ challenge: string;
9183
+ /**
9184
+ * WebAuthn Level 3
9185
+ * [`AuthenticationExtensionsClientInputsJSON`](https://www.w3.org/TR/webauthn-3/#dictdef-authenticationextensionsclientinputsjson).
9186
+ *
9187
+ */
9188
+ extensions?: {};
9189
+ /**
9190
+ * Hints for the browser which authenticator to offer. Not set by this API.
9191
+ */
9192
+ hints?: string[];
9193
+ /**
9194
+ * The relying party, selected from the `Origin` header of the request that created the challenge.
9195
+ */
9196
+ rpId: string;
9197
+ /**
9198
+ * Milliseconds until the challenge expires.
9199
+ */
9200
+ timeout: number;
9201
+ /**
9202
+ * Always `required`; the authenticator has to verify the user (biometrics or device PIN).
9203
+ */
9204
+ userVerification: string;
9205
+ }
8866
9206
  interface DeMittwaldCommonsAddress {
8867
9207
  street: string;
8868
9208
  houseNumber: string;
@@ -10896,6 +11236,13 @@ export declare namespace MittwaldAPIV3Next {
10896
11236
  type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldAppAppInstallation;
10897
11237
  }
10898
11238
  }
11239
+ namespace $403 {
11240
+ namespace Content {
11241
+ interface ApplicationJson {
11242
+ [k: string]: unknown;
11243
+ }
11244
+ }
11245
+ }
10899
11246
  namespace $404 {
10900
11247
  namespace Content {
10901
11248
  interface ApplicationJson {
@@ -10970,6 +11317,10 @@ export declare namespace MittwaldAPIV3Next {
10970
11317
  };
10971
11318
  interface RequestBody {
10972
11319
  appVersionId?: string;
11320
+ /**
11321
+ * Enabling automatic updates may first update the AppInstallation to the newest permitted app version.
11322
+ */
11323
+ autoUpdatesActivated?: boolean;
10973
11324
  customDocumentRoot?: string;
10974
11325
  /**
10975
11326
  * Desired changes to the databases linked to this AppInstallation, keyed by
@@ -17486,6 +17837,13 @@ export declare namespace MittwaldAPIV3Next {
17486
17837
  type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCronjobCronjob;
17487
17838
  }
17488
17839
  }
17840
+ namespace $403 {
17841
+ namespace Content {
17842
+ interface ApplicationJson {
17843
+ [k: string]: unknown;
17844
+ }
17845
+ }
17846
+ }
17489
17847
  namespace $404 {
17490
17848
  namespace Content {
17491
17849
  interface ApplicationJson {
@@ -19385,6 +19743,13 @@ export declare namespace MittwaldAPIV3Next {
19385
19743
  }
19386
19744
  }
19387
19745
  }
19746
+ namespace $403 {
19747
+ namespace Content {
19748
+ interface ApplicationJson {
19749
+ [k: string]: unknown;
19750
+ }
19751
+ }
19752
+ }
19388
19753
  namespace $404 {
19389
19754
  namespace Content {
19390
19755
  interface ApplicationJson {
@@ -19693,6 +20058,13 @@ export declare namespace MittwaldAPIV3Next {
19693
20058
  }
19694
20059
  }
19695
20060
  }
20061
+ namespace $403 {
20062
+ namespace Content {
20063
+ interface ApplicationJson {
20064
+ [k: string]: unknown;
20065
+ }
20066
+ }
20067
+ }
19696
20068
  namespace $404 {
19697
20069
  namespace Content {
19698
20070
  interface ApplicationJson {
@@ -32105,7 +32477,8 @@ export declare namespace MittwaldAPIV3Next {
32105
32477
  /**
32106
32478
  * The second factor - otp code or recovery code.
32107
32479
  */
32108
- multiFactorCode: string;
32480
+ multiFactorCode?: string;
32481
+ passkeyCredential?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredential;
32109
32482
  /**
32110
32483
  * The password of the user.
32111
32484
  */
@@ -32210,7 +32583,12 @@ export declare namespace MittwaldAPIV3Next {
32210
32583
  namespace $202 {
32211
32584
  namespace Content {
32212
32585
  interface ApplicationJson {
32586
+ /**
32587
+ * More values may be added in the future; clients must ignore values they do not know.
32588
+ */
32589
+ availableSecondFactors: ("totp" | "passkey")[];
32213
32590
  name?: "SecondFactorRequired";
32591
+ passkeyChallenge?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyChallenge;
32214
32592
  }
32215
32593
  }
32216
32594
  }
@@ -32384,9 +32762,7 @@ export declare namespace MittwaldAPIV3Next {
32384
32762
  type Path = {};
32385
32763
  interface RequestBody {
32386
32764
  /**
32387
- * Multi Factor Code to confirm MFA.
32388
- * This is optional, depending on the MFA activation status of the profile.
32389
- *
32765
+ * A TOTP code or recovery code.
32390
32766
  */
32391
32767
  multiFactorCode?: string;
32392
32768
  /**
@@ -32397,6 +32773,7 @@ export declare namespace MittwaldAPIV3Next {
32397
32773
  * The old password.
32398
32774
  */
32399
32775
  oldPassword: string;
32776
+ passkeyCredential?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredential;
32400
32777
  }
32401
32778
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
32402
32779
  type Query = {};
@@ -32460,7 +32837,13 @@ export declare namespace MittwaldAPIV3Next {
32460
32837
  namespace $200 {
32461
32838
  namespace Content {
32462
32839
  interface ApplicationJson {
32840
+ /**
32841
+ * TOTP has been confirmed and is active.
32842
+ */
32463
32843
  confirmed: boolean;
32844
+ /**
32845
+ * TOTP has been initialized.
32846
+ */
32464
32847
  initialized: boolean;
32465
32848
  }
32466
32849
  }
@@ -32486,73 +32869,74 @@ export declare namespace MittwaldAPIV3Next {
32486
32869
  type Path = {};
32487
32870
  interface RequestBody {
32488
32871
  /**
32489
- * Multi Factor Code to authorize your request.
32490
- */
32491
- multiFactorCode: string;
32492
- }
32493
- type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
32494
- type Query = {};
32495
- }
32496
- namespace Responses {
32497
- namespace $200 {
32498
- namespace Content {
32499
- interface ApplicationJson {
32500
- /**
32501
- * @minItems 20
32502
- * @maxItems 20
32503
- */
32504
- recoveryCodesList: [
32505
- string,
32506
- string,
32507
- string,
32508
- string,
32509
- string,
32510
- string,
32511
- string,
32512
- string,
32513
- string,
32514
- string,
32515
- string,
32516
- string,
32517
- string,
32518
- string,
32519
- string,
32520
- string,
32521
- string,
32522
- string,
32523
- string,
32524
- string
32525
- ];
32526
- }
32527
- }
32528
- }
32529
- namespace $400 {
32530
- namespace Content {
32531
- type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsValidationErrors;
32532
- }
32533
- }
32534
- namespace $429 {
32535
- namespace Content {
32536
- interface ApplicationJson {
32537
- [k: string]: unknown;
32538
- }
32539
- }
32540
- }
32541
- namespace Default {
32542
- namespace Content {
32543
- interface ApplicationJson {
32544
- [k: string]: unknown;
32545
- }
32546
- }
32547
- }
32548
- }
32549
- }
32550
- namespace Post {
32551
- namespace Parameters {
32552
- type Path = {};
32553
- interface RequestBody {
32554
- /**
32555
- * Multi Factor Code to confirm MFA.
32872
+ * A TOTP code or recovery code.
32873
+ */
32874
+ multiFactorCode?: string;
32875
+ passkeyCredential?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredential;
32876
+ }
32877
+ type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
32878
+ type Query = {};
32879
+ }
32880
+ namespace Responses {
32881
+ namespace $200 {
32882
+ namespace Content {
32883
+ interface ApplicationJson {
32884
+ /**
32885
+ * @minItems 20
32886
+ * @maxItems 20
32887
+ */
32888
+ recoveryCodesList: [
32889
+ string,
32890
+ string,
32891
+ string,
32892
+ string,
32893
+ string,
32894
+ string,
32895
+ string,
32896
+ string,
32897
+ string,
32898
+ string,
32899
+ string,
32900
+ string,
32901
+ string,
32902
+ string,
32903
+ string,
32904
+ string,
32905
+ string,
32906
+ string,
32907
+ string,
32908
+ string
32909
+ ];
32910
+ }
32911
+ }
32912
+ }
32913
+ namespace $400 {
32914
+ namespace Content {
32915
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsValidationErrors;
32916
+ }
32917
+ }
32918
+ namespace $429 {
32919
+ namespace Content {
32920
+ interface ApplicationJson {
32921
+ [k: string]: unknown;
32922
+ }
32923
+ }
32924
+ }
32925
+ namespace Default {
32926
+ namespace Content {
32927
+ interface ApplicationJson {
32928
+ [k: string]: unknown;
32929
+ }
32930
+ }
32931
+ }
32932
+ }
32933
+ }
32934
+ namespace Post {
32935
+ namespace Parameters {
32936
+ type Path = {};
32937
+ interface RequestBody {
32938
+ /**
32939
+ * Multi Factor Code to confirm MFA.
32556
32940
  */
32557
32941
  multiFactorCode: string;
32558
32942
  }
@@ -32618,9 +33002,10 @@ export declare namespace MittwaldAPIV3Next {
32618
33002
  type Path = {};
32619
33003
  interface RequestBody {
32620
33004
  /**
32621
- * Multi Factor Code to confirm MFA.
33005
+ * A TOTP code or recovery code.
32622
33006
  */
32623
- multiFactorCode: string;
33007
+ multiFactorCode?: string;
33008
+ passkeyCredential?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredential;
32624
33009
  }
32625
33010
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
32626
33011
  type Query = {};
@@ -33164,9 +33549,13 @@ export declare namespace MittwaldAPIV3Next {
33164
33549
  type Path = {};
33165
33550
  interface RequestBody {
33166
33551
  /**
33167
- * Multi Factor Code to authorize your request.
33552
+ * A TOTP code or recovery code.
33168
33553
  */
33169
33554
  multiFactorCode?: string;
33555
+ passkeyCredential?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredential;
33556
+ /**
33557
+ * The password of the user.
33558
+ */
33170
33559
  password: string;
33171
33560
  }
33172
33561
  type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
@@ -33192,9 +33581,7 @@ export declare namespace MittwaldAPIV3Next {
33192
33581
  }
33193
33582
  namespace $412 {
33194
33583
  namespace Content {
33195
- interface ApplicationJson {
33196
- [k: string]: unknown;
33197
- }
33584
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
33198
33585
  }
33199
33586
  }
33200
33587
  namespace $429 {
@@ -34720,5 +35107,445 @@ export declare namespace MittwaldAPIV3Next {
34720
35107
  }
34721
35108
  }
34722
35109
  }
35110
+ namespace V3NextAuthenticatePasskey {
35111
+ namespace Post {
35112
+ namespace Parameters {
35113
+ type Path = {};
35114
+ interface RequestBody {
35115
+ challengeId: string;
35116
+ credential: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyAuthenticationResponse;
35117
+ }
35118
+ type Header = {};
35119
+ type Query = {
35120
+ cookieOnly?: boolean;
35121
+ };
35122
+ }
35123
+ namespace Responses {
35124
+ namespace $200 {
35125
+ namespace Content {
35126
+ interface ApplicationJson {
35127
+ /**
35128
+ * The expiration date of the token.
35129
+ */
35130
+ expires: string;
35131
+ /**
35132
+ * Refresh token to refresh your access token even after it has expired.
35133
+ */
35134
+ refreshToken: string;
35135
+ /**
35136
+ * Public token to identify yourself against the api gateway.
35137
+ */
35138
+ token: string;
35139
+ }
35140
+ }
35141
+ }
35142
+ namespace $204 {
35143
+ namespace Content {
35144
+ type Empty = unknown;
35145
+ }
35146
+ }
35147
+ namespace $400 {
35148
+ namespace Content {
35149
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsValidationErrors | MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35150
+ }
35151
+ }
35152
+ namespace $429 {
35153
+ namespace Content {
35154
+ interface ApplicationJson {
35155
+ [k: string]: unknown;
35156
+ }
35157
+ }
35158
+ }
35159
+ namespace $500 {
35160
+ namespace Content {
35161
+ interface ApplicationJson {
35162
+ [k: string]: unknown;
35163
+ }
35164
+ }
35165
+ }
35166
+ namespace Default {
35167
+ namespace Content {
35168
+ interface ApplicationJson {
35169
+ [k: string]: unknown;
35170
+ }
35171
+ }
35172
+ }
35173
+ }
35174
+ }
35175
+ }
35176
+ namespace V3NextPasskeyChallenges {
35177
+ namespace Post {
35178
+ namespace Parameters {
35179
+ type Path = {};
35180
+ type Header = {};
35181
+ type Query = {};
35182
+ }
35183
+ namespace Responses {
35184
+ namespace $201 {
35185
+ namespace Content {
35186
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyChallenge;
35187
+ }
35188
+ }
35189
+ namespace $400 {
35190
+ namespace Content {
35191
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35192
+ }
35193
+ }
35194
+ namespace $429 {
35195
+ namespace Content {
35196
+ interface ApplicationJson {
35197
+ [k: string]: unknown;
35198
+ }
35199
+ }
35200
+ }
35201
+ namespace $500 {
35202
+ namespace Content {
35203
+ interface ApplicationJson {
35204
+ [k: string]: unknown;
35205
+ }
35206
+ }
35207
+ }
35208
+ namespace Default {
35209
+ namespace Content {
35210
+ interface ApplicationJson {
35211
+ [k: string]: unknown;
35212
+ }
35213
+ }
35214
+ }
35215
+ }
35216
+ }
35217
+ }
35218
+ namespace V3NextUsersSelfPasskeysPasskeyId {
35219
+ namespace Delete {
35220
+ namespace Parameters {
35221
+ type Path = {
35222
+ passkeyId: string;
35223
+ };
35224
+ interface RequestBody {
35225
+ /**
35226
+ * A TOTP code or recovery code.
35227
+ */
35228
+ multiFactorCode?: string;
35229
+ passkeyCredential?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredential;
35230
+ }
35231
+ type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
35232
+ type Query = {};
35233
+ }
35234
+ namespace Responses {
35235
+ namespace $204 {
35236
+ namespace Content {
35237
+ type Empty = unknown;
35238
+ }
35239
+ }
35240
+ namespace $400 {
35241
+ namespace Content {
35242
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsValidationErrors;
35243
+ }
35244
+ }
35245
+ namespace $404 {
35246
+ namespace Content {
35247
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35248
+ }
35249
+ }
35250
+ namespace $429 {
35251
+ namespace Content {
35252
+ interface ApplicationJson {
35253
+ [k: string]: unknown;
35254
+ }
35255
+ }
35256
+ }
35257
+ namespace $500 {
35258
+ namespace Content {
35259
+ interface ApplicationJson {
35260
+ [k: string]: unknown;
35261
+ }
35262
+ }
35263
+ }
35264
+ namespace Default {
35265
+ namespace Content {
35266
+ interface ApplicationJson {
35267
+ [k: string]: unknown;
35268
+ }
35269
+ }
35270
+ }
35271
+ }
35272
+ }
35273
+ namespace Patch {
35274
+ namespace Parameters {
35275
+ type Path = {
35276
+ passkeyId: string;
35277
+ };
35278
+ interface RequestBody {
35279
+ name: string;
35280
+ }
35281
+ type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
35282
+ type Query = {};
35283
+ }
35284
+ namespace Responses {
35285
+ namespace $204 {
35286
+ namespace Content {
35287
+ type Empty = unknown;
35288
+ }
35289
+ }
35290
+ namespace $400 {
35291
+ namespace Content {
35292
+ interface ApplicationJson {
35293
+ [k: string]: unknown;
35294
+ }
35295
+ }
35296
+ }
35297
+ namespace $404 {
35298
+ namespace Content {
35299
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35300
+ }
35301
+ }
35302
+ namespace $429 {
35303
+ namespace Content {
35304
+ interface ApplicationJson {
35305
+ [k: string]: unknown;
35306
+ }
35307
+ }
35308
+ }
35309
+ namespace $500 {
35310
+ namespace Content {
35311
+ interface ApplicationJson {
35312
+ [k: string]: unknown;
35313
+ }
35314
+ }
35315
+ }
35316
+ namespace Default {
35317
+ namespace Content {
35318
+ interface ApplicationJson {
35319
+ [k: string]: unknown;
35320
+ }
35321
+ }
35322
+ }
35323
+ }
35324
+ }
35325
+ }
35326
+ namespace V3NextUsersSelfPasskeys {
35327
+ namespace Get {
35328
+ namespace Parameters {
35329
+ type Path = {};
35330
+ type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
35331
+ type Query = {};
35332
+ }
35333
+ namespace Responses {
35334
+ namespace $200 {
35335
+ namespace Content {
35336
+ type ApplicationJson = {
35337
+ /**
35338
+ * The authenticator model identifier.
35339
+ */
35340
+ aaguid: string;
35341
+ /**
35342
+ * Whether the authenticator can back up (sync) the passkey, as reported at registration.
35343
+ */
35344
+ backupEligible: boolean;
35345
+ /**
35346
+ * Whether the passkey was backed up (synced) at registration. Not updated afterwards.
35347
+ */
35348
+ backupState: boolean;
35349
+ createdAt: string;
35350
+ /**
35351
+ * The base64url encoded WebAuthn credential id.
35352
+ */
35353
+ credentialId: string;
35354
+ id: string;
35355
+ name: string;
35356
+ rpId: string;
35357
+ }[];
35358
+ }
35359
+ }
35360
+ namespace $429 {
35361
+ namespace Content {
35362
+ interface ApplicationJson {
35363
+ [k: string]: unknown;
35364
+ }
35365
+ }
35366
+ }
35367
+ namespace $500 {
35368
+ namespace Content {
35369
+ interface ApplicationJson {
35370
+ [k: string]: unknown;
35371
+ }
35372
+ }
35373
+ }
35374
+ namespace Default {
35375
+ namespace Content {
35376
+ interface ApplicationJson {
35377
+ [k: string]: unknown;
35378
+ }
35379
+ }
35380
+ }
35381
+ }
35382
+ }
35383
+ namespace Post {
35384
+ namespace Parameters {
35385
+ type Path = {};
35386
+ interface RequestBody {
35387
+ challengeId: string;
35388
+ credential: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyRegistrationResponse;
35389
+ /**
35390
+ * The display name of the passkey.
35391
+ */
35392
+ name: string;
35393
+ }
35394
+ type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
35395
+ type Query = {};
35396
+ }
35397
+ namespace Responses {
35398
+ namespace $201 {
35399
+ namespace Content {
35400
+ interface ApplicationJson {
35401
+ id: string;
35402
+ /**
35403
+ * Only set if the passkey is the first second factor of the user.
35404
+ */
35405
+ recoveryCodes?: string[];
35406
+ }
35407
+ }
35408
+ }
35409
+ namespace $400 {
35410
+ namespace Content {
35411
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsValidationErrors | MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35412
+ }
35413
+ }
35414
+ namespace $412 {
35415
+ namespace Content {
35416
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35417
+ }
35418
+ }
35419
+ namespace $429 {
35420
+ namespace Content {
35421
+ interface ApplicationJson {
35422
+ [k: string]: unknown;
35423
+ }
35424
+ }
35425
+ }
35426
+ namespace $500 {
35427
+ namespace Content {
35428
+ interface ApplicationJson {
35429
+ [k: string]: unknown;
35430
+ }
35431
+ }
35432
+ }
35433
+ namespace Default {
35434
+ namespace Content {
35435
+ interface ApplicationJson {
35436
+ [k: string]: unknown;
35437
+ }
35438
+ }
35439
+ }
35440
+ }
35441
+ }
35442
+ }
35443
+ namespace V3NextUsersSelfPasskeyChallenges {
35444
+ namespace Post {
35445
+ namespace Parameters {
35446
+ type Path = {};
35447
+ type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
35448
+ type Query = {};
35449
+ }
35450
+ namespace Responses {
35451
+ namespace $201 {
35452
+ namespace Content {
35453
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyChallenge;
35454
+ }
35455
+ }
35456
+ namespace $400 {
35457
+ namespace Content {
35458
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35459
+ }
35460
+ }
35461
+ namespace $429 {
35462
+ namespace Content {
35463
+ interface ApplicationJson {
35464
+ [k: string]: unknown;
35465
+ }
35466
+ }
35467
+ }
35468
+ namespace $500 {
35469
+ namespace Content {
35470
+ interface ApplicationJson {
35471
+ [k: string]: unknown;
35472
+ }
35473
+ }
35474
+ }
35475
+ namespace Default {
35476
+ namespace Content {
35477
+ interface ApplicationJson {
35478
+ [k: string]: unknown;
35479
+ }
35480
+ }
35481
+ }
35482
+ }
35483
+ }
35484
+ }
35485
+ namespace V3NextUsersSelfPasskeyRegistrationChallenges {
35486
+ namespace Post {
35487
+ namespace Parameters {
35488
+ type Path = {};
35489
+ interface RequestBody {
35490
+ /**
35491
+ * A TOTP code or recovery code.
35492
+ */
35493
+ multiFactorCode?: string;
35494
+ passkeyCredential?: MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyCredential;
35495
+ /**
35496
+ * The password of the user.
35497
+ */
35498
+ password: string;
35499
+ }
35500
+ type Header = {} & MittwaldAPIV3Next.Components.SecuritySchemes.DeMittwaldCommonsAccessToken;
35501
+ type Query = {};
35502
+ }
35503
+ namespace Responses {
35504
+ namespace $201 {
35505
+ namespace Content {
35506
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldSignupPasskeyRegistrationChallenge;
35507
+ }
35508
+ }
35509
+ namespace $202 {
35510
+ namespace Content {
35511
+ interface ApplicationJson {
35512
+ [k: string]: unknown;
35513
+ }
35514
+ }
35515
+ }
35516
+ namespace $400 {
35517
+ namespace Content {
35518
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsValidationErrors | MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35519
+ }
35520
+ }
35521
+ namespace $412 {
35522
+ namespace Content {
35523
+ type ApplicationJson = MittwaldAPIV3Next.Components.Schemas.DeMittwaldCommonsError;
35524
+ }
35525
+ }
35526
+ namespace $429 {
35527
+ namespace Content {
35528
+ interface ApplicationJson {
35529
+ [k: string]: unknown;
35530
+ }
35531
+ }
35532
+ }
35533
+ namespace $500 {
35534
+ namespace Content {
35535
+ interface ApplicationJson {
35536
+ [k: string]: unknown;
35537
+ }
35538
+ }
35539
+ }
35540
+ namespace Default {
35541
+ namespace Content {
35542
+ interface ApplicationJson {
35543
+ [k: string]: unknown;
35544
+ }
35545
+ }
35546
+ }
35547
+ }
35548
+ }
35549
+ }
34723
35550
  }
34724
35551
  }