diff --git a/packages/connect-react/src/components/CorbadoConnectDemo.tsx b/packages/connect-react/src/components/CorbadoConnectDemo.tsx index fdb336732..ca5631b69 100644 --- a/packages/connect-react/src/components/CorbadoConnectDemo.tsx +++ b/packages/connect-react/src/components/CorbadoConnectDemo.tsx @@ -39,6 +39,9 @@ const getListOfPasskeys = () => { iconLight: 'https://cdn.cloud.corbado.io/aaguidIcons/01020304-0506-0708-0102-030405060708/light.png', name: 'Passkey', }, + createdMs: 1735689600000, + lastUsedMs: 1735689600000, + tags: [], }, { aaguidDetails: { @@ -58,6 +61,9 @@ const getListOfPasskeys = () => { sourceOS: 'macOS', status: 'active', transport: ['nfc', 'usb'], + createdMs: 1735689600000, + lastUsedMs: 1735689600000, + tags: [], }, { aaguidDetails: { @@ -77,6 +83,9 @@ const getListOfPasskeys = () => { sourceOS: 'macOS', status: 'active', transport: ['hybrid', 'internal'], + createdMs: 1735689600000, + lastUsedMs: 1735689600000, + tags: [], }, ]; diff --git a/packages/web-core/openapi/spec_v2.yaml b/packages/web-core/openapi/spec_v2.yaml index 52a5aab50..89cb85868 100644 --- a/packages/web-core/openapi/spec_v2.yaml +++ b/packages/web-core/openapi/spec_v2.yaml @@ -16,7 +16,11 @@ info: url: https://www.corbado.com servers: - - url: https://.frontendapi.corbado.io + - url: https://{projectId}.frontendapi.corbado.io + variables: + projectId: + description: Your Corbado project ID + default: pro-000000 tags: - name: Auth @@ -31,47 +35,53 @@ tags: paths: /v2/session-config: get: - description: tbd + summary: Retrieve session configuration + description: Retrieves the session configuration settings. operationId: GetSessionConfig tags: - Configs responses: - '200': - description: tbd + "200": + description: Session configuration settings. content: application/json: schema: - $ref: '#/components/schemas/sessionConfigRsp' + $ref: "#/components/schemas/sessionConfigRsp" /v2/user-details-config: get: - description: Gets configs needed by the UserDetails component + summary: Retrieve user details configuration + description: Retrieves user details configuration needed by the UserDetails component. operationId: GetUserDetailsConfig tags: - Configs responses: - '200': - description: tbd + "200": + description: User details configuration. content: application/json: schema: - $ref: '#/components/schemas/userDetailsConfigRsp' + $ref: "#/components/schemas/userDetailsConfigRsp" /v2/me: get: - description: Gets current user + summary: Retrieve current user + description: | + Retrieves data of currently logged in user including their [login identifiers](/api-reference/backend-api/loginidentifiers/create-a-login-identifier-for-a-user) and [social logins](/api-reference/backend-api/users/create-a-social-login-for-a-user). operationId: CurrentUserGet tags: - Users responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/meRsp' + $ref: "#/components/schemas/meRsp" patch: - description: Updates current user + summary: Update current User + description: | + Updates data of currently logged in user. operationId: CurrentUserUpdate tags: - Users @@ -80,36 +90,42 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/meUpdateReq' + $ref: "#/components/schemas/meUpdateReq" responses: - '200': - $ref: '#/components/responses/200' + "200": + $ref: "#/components/responses/200" delete: - description: Deletes current user + summary: Delete current user + description: | + Deletes currently logged in user. operationId: CurrentUserDelete tags: - Users responses: - '200': - $ref: '#/components/responses/200' + "200": + $ref: "#/components/responses/200" /v2/me/passkeys: get: - description: Gets current user's passkeys + summary: List all user passkeys + description: | + Returns a list of passkeys for the currently logged in user. operationId: CurrentUserPasskeyGet tags: - Users responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/mePasskeyRsp' + $ref: "#/components/schemas/mePasskeyRsp" /v2/me/passkeys/append/start: post: - description: Starts passkey append for current user + summary: Start passkey append + description: | + Starts passkey append for currently logged in user. operationId: CurrentUserPasskeyAppendStart tags: - Users @@ -118,18 +134,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/mePasskeysAppendStartReq' + $ref: "#/components/schemas/mePasskeysAppendStartReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/mePasskeysAppendStartRsp' + $ref: "#/components/schemas/mePasskeysAppendStartRsp" /v2/me/passkeys/append/finish: post: - description: Finishes passkey append for current user + summary: Finish passkey append + description: | + Finishes passkey append for currently logged in user. operationId: CurrentUserPasskeyAppendFinish tags: - Users @@ -138,14 +156,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/mePasskeysAppendFinishReq' + $ref: "#/components/schemas/mePasskeysAppendFinishReq" responses: - '200': + "200": description: tbd /v2/me/passkeys/{credentialID}: delete: - description: Delete current user's passkeys + summary: Delete user passkey + description: | + Deletes a passkey for the currently logged in user. operationId: CurrentUserPasskeyDelete tags: - Users @@ -155,43 +175,53 @@ paths: name: credentialID schema: type: string - description: 'Credential ID from passkeys' - example: 'cre-abc123' + description: Unique identifier of the passkey. + example: "cre-940364795071150919" responses: - '200': + "200": description: tbs content: application/json: schema: - $ref: '#/components/schemas/mePasskeyDeleteRsp' + $ref: "#/components/schemas/mePasskeyDeleteRsp" /v2/me/refresh: post: - description: Performs session refresh + summary: Refresh user session + description: | + Performs session refresh of currently logged in user. Issues a new session-token if session is still valid. + + Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. operationId: CurrentUserSessionRefresh tags: - Users responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/meRefreshRsp' + $ref: "#/components/schemas/meRefreshRsp" /v2/me/logout: post: - description: Performs session logout + summary: Logout user + description: | + Performs session logout of currently logged in user. + + Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. operationId: CurrentUserSessionLogout tags: - Users responses: - '204': + "204": description: tbd /v2/me/identifier: post: - description: Creates an identifier + summary: Create login identifier + description: | + Creates a login identifier for the currently logged in user. operationId: CurrentUserIdentifierCreate tags: - Users @@ -200,12 +230,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/meIdentifierCreateReq' + $ref: "#/components/schemas/meIdentifierCreateReq" responses: - '200': - $ref: '#/components/responses/200' + "200": + $ref: "#/components/responses/200" delete: - description: Deletes an identifier + summary: Delete login identifier + description: | + Deletes a login identifier for the currently logged in user. operationId: CurrentUserIdentifierDelete tags: - Users @@ -214,12 +246,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/meIdentifierDeleteReq' + $ref: "#/components/schemas/meIdentifierDeleteReq" responses: - '200': - $ref: '#/components/responses/200' + "200": + $ref: "#/components/responses/200" patch: - description: Modifies an identifier (only permitted for username; identifierID will change) + summary: Update login identifier + description: | + Updates a login identifier for the currently logged in user. operationId: CurrentUserIdentifierUpdate tags: - Users @@ -228,14 +262,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/meIdentifierUpdateReq' + $ref: "#/components/schemas/meIdentifierUpdateReq" responses: - '200': - $ref: '#/components/responses/200' + "200": + $ref: "#/components/responses/200" /v2/me/identifier/verify/start: post: - description: Creates challenge (only email otp and phone otp supported for now) + summary: Start login identifier verification + description: | + Starts login identifer verification of currently logged in user. operationId: CurrentUserIdentifierVerifyStart tags: - Users @@ -244,14 +280,16 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/meIdentifierVerifyStartReq' + $ref: "#/components/schemas/meIdentifierVerifyStartReq" responses: - '200': - $ref: '#/components/responses/200' + "200": + $ref: "#/components/responses/200" /v2/me/identifier/verify/finish: post: - description: Verifies challenge + summary: Finish login identifier verification + description: | + Finishes login identifer verification of currently logged in user. operationId: CurrentUserIdentifierVerifyFinish tags: - Users @@ -260,14 +298,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/meIdentifierVerifyFinishReq' + $ref: "#/components/schemas/meIdentifierVerifyFinishReq" responses: - '200': - $ref: '#/components/responses/200' + "200": + $ref: "#/components/responses/200" /v2/auth/process/init: post: - description: tbd + summary: Initialize authentication process + description: Initializes a new authentication process. operationId: ProcessInit tags: - Auth @@ -276,18 +315,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/processInitReq' + $ref: "#/components/schemas/processInitReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processInitRsp' + $ref: "#/components/schemas/processInitRsp" /v2/auth/process: get: - description: tbd + summary: Retrieve authentication process + description: Retrieves the current authentication process state. operationId: ProcessGet tags: - Auth @@ -296,46 +336,49 @@ paths: required: false name: preferredBlock schema: - $ref: '#/components/schemas/blockType' + $ref: "#/components/schemas/blockType" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/process/complete: post: - description: tbd + summary: Complete authentication process + description: Completes the current authentication process. operationId: ProcessComplete tags: - Auth responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/process/reset: post: - description: tbd + summary: Reset authentication process + description: Resets the current authentication process. operationId: ProcessReset tags: - Auth responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/signup/init: post: - description: tbd + summary: Initialize signup + description: Initializes a new user signup process. operationId: SignupInit tags: - Auth @@ -344,18 +387,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/signupInitReq' + $ref: "#/components/schemas/signupInitReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/login/init: post: - description: tbd + summary: Initialize login + description: Initializes a new login process. operationId: LoginInit tags: - Auth @@ -364,32 +408,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/loginInitReq' + $ref: "#/components/schemas/loginInitReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/block/skip: post: - description: tbd + summary: Skip authentication block + description: Skips the current authentication block. operationId: BlockSkip tags: - Auth responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/passkey/append/start: post: - description: tbd + summary: Start passkey append + description: Starts the process of appending a new passkey. operationId: PasskeyAppendStart tags: - Auth @@ -398,18 +444,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/passkeyAppendStartReq' + $ref: "#/components/schemas/passkeyAppendStartReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/passkey/append/finish: post: - description: tbd + summary: Finish passkey append + description: Completes the process of appending a new passkey. operationId: PasskeyAppendFinish tags: - Auth @@ -418,18 +465,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/passkeyAppendFinishReq' + $ref: "#/components/schemas/passkeyAppendFinishReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/passkey/login/start: post: - description: tbd + summary: Start passkey login + description: Initiates the passkey login process. operationId: PasskeyLoginStart tags: - Auth @@ -438,18 +486,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/passkeyLoginStartReq' + $ref: "#/components/schemas/passkeyLoginStartReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/passkey/login/finish: post: - description: tbd + summary: Finish passkey login + description: Completes the passkey login process. operationId: PasskeyLoginFinish tags: - Auth @@ -458,18 +507,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/passkeyLoginFinishReq' + $ref: "#/components/schemas/passkeyLoginFinishReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/passkey/mediation/finish: post: - description: tbd + summary: Finish passkey mediation + description: Completes the passkey mediation process. operationId: PasskeyMediationFinish tags: - Auth @@ -478,18 +528,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/passkeyMediationFinishReq' + $ref: "#/components/schemas/passkeyMediationFinishReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/identifier/verify/start: post: - description: tbd + summary: Start identifier verification + description: Initiates the identifier verification process. operationId: IdentifierVerifyStart tags: - Auth @@ -498,18 +549,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/identifierVerifyStartReq' + $ref: "#/components/schemas/identifierVerifyStartReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/identifier/verify/finish: post: - description: tbd + summary: Finish identifier verification + description: Completes the identifier verification process. operationId: IdentifierVerifyFinish tags: - Auth @@ -518,32 +570,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/identifierVerifyFinishReq' + $ref: "#/components/schemas/identifierVerifyFinishReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/identifier/verify/status: get: - description: tbd + summary: Retrieve identifier verification status + description: Retrieves the current status of identifier verification. operationId: IdentifierVerifyStatus tags: - Auth responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/identifier/update: post: - description: tbd + summary: Update identifier + description: Updates the user's identifier information. operationId: IdentifierUpdate tags: - Auth @@ -552,18 +606,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/identifierUpdateReq' + $ref: "#/components/schemas/identifierUpdateReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/social/verify/start: post: - description: tbd + summary: Start social verification + description: Initiates the social authentication verification process. operationId: SocialVerifyStart tags: - Auth @@ -572,28 +627,30 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/socialVerifyStartReq' + $ref: "#/components/schemas/socialVerifyStartReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/social/verify/callback: get: - description: tbd + summary: Social verification callback + description: Handles the callback from social authentication providers. operationId: SocialVerifyCallback tags: - Auth responses: - '200': + "200": description: tbd /v2/auth/social/verify/finish: post: - description: tbd + summary: Finish social verification + description: Completes the social authentication verification process. operationId: SocialVerifyFinish tags: - Auth @@ -602,17 +659,18 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/socialVerifyFinishReq' + $ref: "#/components/schemas/socialVerifyFinishReq" responses: - '200': + "200": description: tbd content: application/json: schema: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" /v2/auth/events: post: + summary: Create authentication event description: Creates a new user generated complete event. operationId: EventCreate tags: @@ -622,14 +680,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/eventCreateReq' + $ref: "#/components/schemas/eventCreateReq" responses: - '204': + "204": description: tbd /v2/connect/login/init: post: - description: Initializes a connect process for login. + summary: Initialize connect login + description: Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for login. operationId: ConnectLoginInit tags: - CorbadoConnect @@ -638,18 +697,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectLoginInitReq' + $ref: "#/components/schemas/connectLoginInitReq" responses: - '200': + "200": description: Contains information about if and how a passkey login can be started. content: application/json: schema: - $ref: '#/components/schemas/connectLoginInitRsp' + $ref: "#/components/schemas/connectLoginInitRsp" /v2/connect/login/start: post: - description: Starts an initialized connect login process. + summary: Start connect login + description: Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. operationId: ConnectLoginStart tags: - CorbadoConnect @@ -658,20 +718,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectLoginStartReq' + $ref: "#/components/schemas/connectLoginStartReq" responses: - '200': + "200": description: Contains the challenge for the passkey login. content: application/json: schema: - $ref: '#/components/schemas/connectLoginStartRsp' - '404': + $ref: "#/components/schemas/connectLoginStartRsp" + "404": description: No user was found for the identifier /v2/connect/login/finish: post: - description: Finishes an initialized connect login process. + summary: Finish connect login + description: Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. operationId: ConnectLoginFinish tags: - CorbadoConnect @@ -680,20 +741,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectLoginFinishReq' + $ref: "#/components/schemas/connectLoginFinishReq" responses: - '200': + "200": description: Data about the passkey login and the session. content: application/json: schema: - $ref: '#/components/schemas/connectLoginFinishRsp' - '404': + $ref: "#/components/schemas/connectLoginFinishRsp" + "404": description: No credential was found for the identifier /v2/connect/append/init: post: - description: Initializes a connect process for passkey append. + summary: Initialize connect append + description: Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey append. operationId: ConnectAppendInit tags: - CorbadoConnect @@ -702,18 +764,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectAppendInitReq' + $ref: "#/components/schemas/connectAppendInitReq" responses: - '200': + "200": description: Contains information about if and how a passkey append can be started. content: application/json: schema: - $ref: '#/components/schemas/connectAppendInitRsp' + $ref: "#/components/schemas/connectAppendInitRsp" /v2/connect/append/start: post: - description: Starts an initialized connect passkey append process. + summary: Start connect append + description: Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. operationId: ConnectAppendStart tags: - CorbadoConnect @@ -722,18 +785,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectAppendStartReq' + $ref: "#/components/schemas/connectAppendStartReq" responses: - '200': + "200": description: Contains the challenge for the passkey append. content: application/json: schema: - $ref: '#/components/schemas/connectAppendStartRsp' + $ref: "#/components/schemas/connectAppendStartRsp" /v2/connect/append/finish: post: - description: Finishes an initialized connect passkey append process. + summary: Finish connect append + description: Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. operationId: ConnectAppendFinish tags: - CorbadoConnect @@ -742,18 +806,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectAppendFinishReq' + $ref: "#/components/schemas/connectAppendFinishReq" responses: - '200': + "200": description: Data about the new passkey. content: application/json: schema: - $ref: '#/components/schemas/connectAppendFinishRsp' + $ref: "#/components/schemas/connectAppendFinishRsp" /v2/connect/manage/init: post: - description: Initializes a connect process for passkey management. + summary: Initialize connect management + description: Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey management. operationId: ConnectManageInit tags: - CorbadoConnect @@ -762,18 +827,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectManageInitReq' + $ref: "#/components/schemas/connectManageInitReq" responses: - '200': + "200": description: Contains information about if and how passkey management can be started. content: application/json: schema: - $ref: '#/components/schemas/connectManageInitRsp' + $ref: "#/components/schemas/connectManageInitRsp" /v2/connect/manage/delete: post: - description: Deletes a passkey for a user identified by a connect token + summary: Delete connect passkey + description: Deletes a passkey for a user identified by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. operationId: ConnectManageDelete tags: - CorbadoConnect @@ -782,18 +848,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectManageDeleteReq' + $ref: "#/components/schemas/connectManageDeleteReq" responses: - '200': + "200": description: Contains the ID of the deleted passkey. content: application/json: schema: - $ref: '#/components/schemas/connectManageDeleteRsp' + $ref: "#/components/schemas/connectManageDeleteRsp" /v2/connect/manage/list: post: - description: Lists all passkeys for a user identifier by a connect token. + summary: List connect passkeys + description: Lists all passkeys for a user identifier by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. operationId: ConnectManageList tags: - CorbadoConnect @@ -802,18 +869,19 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectManageListReq' + $ref: "#/components/schemas/connectManageListReq" responses: - '200': + "200": description: Contains all passkeys for a user. content: application/json: schema: - $ref: '#/components/schemas/connectManageListRsp' + $ref: "#/components/schemas/connectManageListRsp" /v2/connect/events: post: - description: Creates a new user generated connect event. + summary: Create connect event + description: Creates a new user generated [Corbado Connect](https://docs.corbado.com/corbado-connect) event. operationId: ConnectEventCreate tags: - CorbadoConnect @@ -822,14 +890,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectEventCreateReq' + $ref: "#/components/schemas/connectEventCreateReq" responses: - '204': + "204": description: tbd /v2/connect/process/clear: post: - description: Remove process state for a connect process. + summary: Clear connect process + description: Remove process state for a [Corbado Connect](https://docs.corbado.com/corbado-connect) process. operationId: ConnectProcessClear tags: - CorbadoConnect @@ -838,15 +907,15 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/connectProcessClearReq' + $ref: "#/components/schemas/connectProcessClearReq" responses: - '200': + "200": description: Contains information about the process state. content: application/json: schema: - $ref: '#/components/schemas/connectProcessClearRsp' - '404': + $ref: "#/components/schemas/connectProcessClearRsp" + "404": description: No process was found for the token components: @@ -861,11 +930,23 @@ components: type: http scheme: bearer bearerFormat: JWT + description: | + After a user logs in successfully, a session is created and a JWT token is returned. + This token represents the user's authenticated session. + It must be included in the `Authorization` header as a Bearer token for all protected endpoints: + + `Authorization: Bearer ` + + The server will validate this token to authorize access. projectID: + type: apiKey in: header name: X-Corbado-ProjectID - type: apiKey + description: | + Identifies your project context for Corbado. + Include this in the request headers as: + `X-Corbado-ProjectID: ` schemas: processInitReq: type: object @@ -874,7 +955,7 @@ components: - clientInformation properties: clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" passkeyAppendShown: type: integer format: int64 @@ -882,7 +963,7 @@ components: type: boolean description: deprecated preferredBlock: - $ref: '#/components/schemas/blockType' + $ref: "#/components/schemas/blockType" processInitRsp: type: object @@ -899,7 +980,7 @@ components: expiresAt: type: integer processResponse: - $ref: '#/components/schemas/processResponse' + $ref: "#/components/schemas/processResponse" signupInitReq: type: object @@ -912,7 +993,7 @@ components: identifiers: type: array items: - $ref: '#/components/schemas/loginIdentifier' + $ref: "#/components/schemas/loginIdentifier" # signupInitRsp: # $ref: '#/components/schemas/blockBody' @@ -929,7 +1010,6 @@ components: isPhone: type: boolean - # loginInitRsp: # $ref: '#/components/schemas/blockBody' @@ -937,7 +1017,7 @@ components: type: object properties: clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" passkeyAppendFinishReq: type: object @@ -957,7 +1037,7 @@ components: - clientInformation properties: clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" mePasskeysAppendStartRsp: type: object @@ -968,7 +1048,7 @@ components: type: string appendNotAllowedReason: type: string - enum: [ 'passkey_already_exists', 'passkeys_not_supported' ] + enum: ["passkey_already_exists", "passkeys_not_supported"] attestationOptions: type: string example: '{"publicKey":{"challenge":"2m6...0w9/MgW...KE=","rp":{"name":"demo","id":"localhost"},"user":{"name":"example@mail.com","id":"dXN...zk5"},"pubKeyCredParams":[{"type":"public-key","alg":-7},{"type":"public-key","alg":-35},{"type":"public-key","alg":-36},{"type":"public-key","alg":-257},{"type":"public-key","alg":-258},{"type":"public-key","alg":-259},{"type":"public-key","alg":-37},{"type":"public-key","alg":-38},{"type":"public-key","alg":-39},{"type":"public-key","alg":-8}],"authenticatorSelection":{"authenticatorAttachment":"platform","requireResidentKey":false,"userVerification":"required"},"timeout":60000,"attestation":"none"}}' @@ -983,7 +1063,7 @@ components: type: string example: '{"type":"public-key","id":"JM6...J_Q","rawId":"JM6...J_Q","authenticatorAttachment":null,"response":{"clientDataJSON":"eyJ...ZX0","authenticatorData":"SZY...AAQ","signature":"Ni7...YAg","userHandle":"dXN...zk5"},"clientExtensionResults":{}}' clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" meIdentifierCreateReq: type: object @@ -992,7 +1072,7 @@ components: - value properties: identifierType: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" value: type: string @@ -1014,7 +1094,7 @@ components: identifierID: type: string identifierType: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" value: type: string @@ -1028,7 +1108,7 @@ components: identifierID: type: string clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" meIdentifierVerifyFinishReq: type: object @@ -1048,7 +1128,7 @@ components: type: object properties: clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" # passkeyLoginStartRsp: # $ref: '#/components/schemas/blockBody' @@ -1079,9 +1159,9 @@ components: - verificationType properties: identifierType: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" verificationType: - $ref: '#/components/schemas/verificationMethod' + $ref: "#/components/schemas/verificationMethod" identifierVerifyFinishReq: type: object @@ -1094,9 +1174,9 @@ components: code: type: string identifierType: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" verificationType: - $ref: '#/components/schemas/verificationMethod' + $ref: "#/components/schemas/verificationMethod" isNewDevice: type: boolean @@ -1108,11 +1188,11 @@ components: - authType properties: providerType: - $ref: 'common.yml#/components/schemas/socialProviderType' + $ref: "common.yml#/components/schemas/socialProviderType" redirectUrl: type: string authType: - $ref: '#/components/schemas/authType' + $ref: "#/components/schemas/authType" socialVerifyFinishReq: type: object @@ -1124,7 +1204,7 @@ components: - identifierType properties: identifierType: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" value: type: string @@ -1136,9 +1216,9 @@ components: useSessionManagement: type: boolean shortSessionCookieConfig: - $ref: '#/components/schemas/shortSessionCookieConfig' + $ref: "#/components/schemas/shortSessionCookieConfig" sessionTokenCookieConfig: - $ref: '#/components/schemas/sessionTokenCookieConfig' + $ref: "#/components/schemas/sessionTokenCookieConfig" frontendApiUrl: type: string @@ -1153,7 +1233,7 @@ components: identifiers: type: array items: - $ref: '#/components/schemas/loginIdentifierConfig' + $ref: "#/components/schemas/loginIdentifierConfig" mePasskeyRsp: type: object @@ -1164,9 +1244,9 @@ components: passkeys: type: array items: - $ref: '#/components/schemas/passkey' + $ref: "#/components/schemas/passkey" paging: - $ref: 'common.yml#/components/schemas/paging' + $ref: "common.yml#/components/schemas/paging" meRefreshRsp: type: object @@ -1195,7 +1275,7 @@ components: - flags properties: clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" flags: type: object additionalProperties: @@ -1216,8 +1296,11 @@ components: type: string newClientEnvHandle: type: string + newClientState: + type: string expiresAt: type: integer + format: int64 frontendApiUrl: type: string loginAllowed: @@ -1240,7 +1323,7 @@ components: type: string source: type: string - enum: [ 'one-tap', 'text-field', 'error-soft', 'error-hard' ] + enum: ["one-tap", "text-field", "error-soft", "error-hard"] loadedMs: type: integer format: int64 @@ -1249,7 +1332,7 @@ components: identifierHintAvailable: type: boolean oneTapMeta: - $ref: '#/components/schemas/clientStateMeta' + $ref: "#/components/schemas/clientStateMeta" connectLoginStartRsp: type: object @@ -1263,7 +1346,9 @@ components: isCDA: type: boolean fallbackOperationError: - $ref: '#/components/schemas/fallbackOperationError' + $ref: "#/components/schemas/fallbackOperationError" + preferImmediatelyAvailable: + type: boolean connectLoginFinishReq: type: object @@ -1282,18 +1367,17 @@ components: connectLoginFinishRsp: type: object required: - - passkeyOperation - session - signedPasskeyData properties: passkeyOperation: - $ref: '#/components/schemas/passkeyOperation' + $ref: "#/components/schemas/passkeyOperation" session: type: string signedPasskeyData: type: string fallbackOperationError: - $ref: '#/components/schemas/fallbackOperationError' + $ref: "#/components/schemas/fallbackOperationError" connectAppendInitReq: type: object @@ -1302,7 +1386,7 @@ components: - flags properties: clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" flags: type: object additionalProperties: @@ -1325,6 +1409,7 @@ components: type: string expiresAt: type: integer + format: int64 frontendApiUrl: type: string appendAllowed: @@ -1333,6 +1418,8 @@ components: type: object additionalProperties: type: string + newClientState: + type: string connectAppendStartReq: type: object @@ -1383,7 +1470,7 @@ components: - passkeyOperation properties: passkeyOperation: - $ref: '#/components/schemas/passkeyOperation' + $ref: "#/components/schemas/passkeyOperation" connectManageInitReq: type: object @@ -1392,7 +1479,7 @@ components: - flags properties: clientInformation: - $ref: '#/components/schemas/clientInformation' + $ref: "#/components/schemas/clientInformation" flags: type: object additionalProperties: @@ -1415,6 +1502,7 @@ components: type: string expiresAt: type: integer + format: int64 frontendApiUrl: type: string manageAllowed: @@ -1453,7 +1541,7 @@ components: passkeys: type: array items: - $ref: '#/components/schemas/passkey' + $ref: "#/components/schemas/passkey" rpID: type: string userID: @@ -1473,7 +1561,7 @@ components: - eventType properties: eventType: - $ref: '#/components/schemas/passkeyEventType' + $ref: "#/components/schemas/passkeyEventType" message: type: string challenge: @@ -1495,6 +1583,9 @@ components: - lastUsed - created - status + - createdMs + - lastUsedMs + - tags properties: id: type: string @@ -1507,7 +1598,15 @@ components: type: array items: type: string - enum: [ 'usb', 'nfc', 'ble', 'internal', 'hybrid', 'smart-card' ] + enum: + [ + "usb", + "nfc", + "ble", + "internal", + "hybrid", + "smart-card" + ] backupEligible: type: boolean backupState: @@ -1522,13 +1621,26 @@ components: type: string description: Timestamp of when the passkey was last used in yyyy-MM-dd'T'HH:mm:ss format created: - $ref: 'common.yml#/components/schemas/created' + $ref: "common.yml#/components/schemas/created" status: type: string - enum: [ 'pending', 'active' ] + enum: ["pending", "active"] description: "Status" aaguidDetails: - $ref: '#/components/schemas/aaguidDetails' + $ref: "#/components/schemas/aaguidDetails" + createdMs: + type: integer + format: int64 + description: Unix timestamp of when the passkey was created (in milliseconds) + lastUsedMs: + type: integer + format: int64 + description: Unix timestamp of when the passkey was last used (in milliseconds) + tags: + type: array + items: + type: string + description: "Tags attached to a passkey (e.g. synced or hybrid)" connectProcessClearReq: type: object @@ -1567,11 +1679,11 @@ components: - common properties: blockBody: - $ref: '#/components/schemas/blockBody' + $ref: "#/components/schemas/blockBody" common: - $ref: '#/components/schemas/processCommon' + $ref: "#/components/schemas/processCommon" newProcess: - $ref: '#/components/schemas/processStaticInfo' + $ref: "#/components/schemas/processStaticInfo" eventCreateReq: type: object @@ -1579,7 +1691,7 @@ components: - eventType properties: eventType: - $ref: '#/components/schemas/passkeyEventType' + $ref: "#/components/schemas/passkeyEventType" challenge: type: string @@ -1627,7 +1739,7 @@ components: type: boolean sameSite: type: string - enum: [ 'lax', 'strict', 'none' ] + enum: ["lax", "strict", "none"] path: type: string lifetimeSeconds: @@ -1648,7 +1760,7 @@ components: type: boolean sameSite: type: string - enum: [ 'lax', 'strict', 'none' ] + enum: ["lax", "strict", "none"] path: type: string lifetimeSeconds: @@ -1660,7 +1772,7 @@ components: - type properties: type: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" blockBody: type: object @@ -1670,30 +1782,30 @@ components: - authType properties: block: - $ref: '#/components/schemas/blockType' + $ref: "#/components/schemas/blockType" authType: - $ref: '#/components/schemas/authType' + $ref: "#/components/schemas/authType" data: type: object discriminator: propertyName: blockType oneOf: - - $ref: '#/components/schemas/generalBlockPasskeyAppend' - - $ref: '#/components/schemas/generalBlockPasskeyVerify' - - $ref: '#/components/schemas/generalBlockVerifyIdentifier' - - $ref: '#/components/schemas/generalBlockPasskeyAppended' - - $ref: '#/components/schemas/generalBlockCompleted' - - $ref: '#/components/schemas/generalBlockSignupInit' - - $ref: '#/components/schemas/generalBlockLoginInit' - - $ref: '#/components/schemas/generalBlockPostSignupEmailVerify' + - $ref: "#/components/schemas/generalBlockPasskeyAppend" + - $ref: "#/components/schemas/generalBlockPasskeyVerify" + - $ref: "#/components/schemas/generalBlockVerifyIdentifier" + - $ref: "#/components/schemas/generalBlockPasskeyAppended" + - $ref: "#/components/schemas/generalBlockCompleted" + - $ref: "#/components/schemas/generalBlockSignupInit" + - $ref: "#/components/schemas/generalBlockLoginInit" + - $ref: "#/components/schemas/generalBlockPostSignupEmailVerify" alternatives: type: array items: - $ref: '#/components/schemas/blockBody' + $ref: "#/components/schemas/blockBody" error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" continueOnOtherDevice: - $ref: '#/components/schemas/continueOnOtherDevice' + $ref: "#/components/schemas/continueOnOtherDevice" loginIdentifier: type: object @@ -1702,7 +1814,7 @@ components: - identifier properties: type: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" identifier: type: string @@ -1713,11 +1825,11 @@ components: - identifier properties: type: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" identifier: type: string error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" fullNameWithError: type: object @@ -1727,31 +1839,65 @@ components: fullName: type: string error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" loginIdentifierType: type: string - enum: [ email, phone, username ] + enum: [email, phone, username] passkeyEventType: type: string - enum: [ login-explicit-abort, login-error, login-error-untyped, login-error-unexpected, login-one-tap-switch, user-append-after-cross-platform-blacklisted, user-append-after-login-error-blacklisted, append-credential-exists, append-explicit-abort, append-error, append-error-unexpected, manage-error-unexpected, append-learn-more ] + enum: + [ + login-explicit-abort, + login-error, + login-error-untyped, + login-error-unexpected, + login-one-tap-switch, + login-no-credentials, + user-append-after-cross-platform-blacklisted, + user-append-after-login-error-blacklisted, + append-credential-exists, + append-explicit-abort, + append-error, + append-error-unexpected, + append-learn-more, + manage-error-unexpected, + manage-error, + manage-learn-more, + manage-credential-exists, + local-unlock + ] blockType: type: string - enum: [ signup-init, passkey-append, phone-verify, email-verify, passkey-appended, completed, social-verify, login-init, passkey-verify, conditional-ui-completed, post-signup-email-verify, passkey-append-after-hybrid ] + enum: + [ + signup-init, + passkey-append, + phone-verify, + email-verify, + passkey-appended, + completed, + social-verify, + login-init, + passkey-verify, + conditional-ui-completed, + post-signup-email-verify, + passkey-append-after-hybrid + ] authType: type: string - enum: [ signup, login ] + enum: [signup, login] verificationMethod: type: string - enum: [ email-link, email-otp, phone-otp ] + enum: [email-link, email-otp, phone-otp] passkeyIconSet: type: string - enum: [ default, apple, android, windows ] + enum: [default, apple, android, windows] generalBlockSignupInit: type: object @@ -1765,13 +1911,13 @@ components: identifiers: type: array items: - $ref: '#/components/schemas/loginIdentifierWithError' + $ref: "#/components/schemas/loginIdentifierWithError" fullName: - $ref: '#/components/schemas/fullNameWithError' + $ref: "#/components/schemas/fullNameWithError" socialData: - $ref: '#/components/schemas/socialData' + $ref: "#/components/schemas/socialData" error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" generalBlockLoginInit: type: object @@ -1799,11 +1945,11 @@ components: isUsernameAvailable: type: boolean socialData: - $ref: '#/components/schemas/socialData' + $ref: "#/components/schemas/socialData" fieldError: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" generalBlockPasskeyAppend: type: object @@ -1823,14 +1969,20 @@ components: identifierValue: type: string identifierType: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" autoSubmit: type: boolean passkeyIconSet: - $ref: '#/components/schemas/passkeyIconSet' + $ref: "#/components/schemas/passkeyIconSet" variant: type: string - enum: [ 'default', 'after-hybrid', 'after-error' ] + enum: + [ + "default", + "after-hybrid", + "after-error", + "after-no-credential" + ] generalBlockPasskeyVerify: type: object @@ -1847,7 +1999,7 @@ components: type: string loginHint: type: string - enum: [ "cda" ] + enum: ["cda"] generalBlockPasskeyAppended: type: object @@ -1879,8 +2031,7 @@ components: sessionToken: type: string passkeyOperation: - $ref: '#/components/schemas/passkeyOperation' - + $ref: "#/components/schemas/passkeyOperation" generalBlockVerifyIdentifier: type: object @@ -1894,14 +2045,14 @@ components: blockType: type: string verificationMethod: - $ref: '#/components/schemas/verificationMethod' + $ref: "#/components/schemas/verificationMethod" identifier: type: string retryNotBefore: type: integer format: int32 error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" alternativeVerificationMethods: type: array items: @@ -1911,7 +2062,7 @@ components: - identifier properties: verificationMethod: - $ref: '#/components/schemas/verificationMethod' + $ref: "#/components/schemas/verificationMethod" identifier: type: string isPostLoginVerification: @@ -1925,7 +2076,7 @@ components: blockType: type: string error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" clientInformation: type: object @@ -1944,9 +2095,9 @@ components: isConditionalMediationAvailable: type: boolean clientCapabilities: - $ref: '#/components/schemas/clientCapabilities' + $ref: "#/components/schemas/clientCapabilities" javaScriptHighEntropy: - $ref: '#/components/schemas/javaScriptHighEntropy' + $ref: "#/components/schemas/javaScriptHighEntropy" isNative: type: boolean webdriver: @@ -1954,7 +2105,9 @@ components: privateMode: type: boolean clientEnvHandleMeta: - $ref: '#/components/schemas/clientStateMeta' + $ref: "#/components/schemas/clientStateMeta" + nativeMeta: + $ref: "#/components/schemas/nativeMeta" clientStateMeta: type: object @@ -1964,9 +2117,43 @@ components: properties: ts: type: integer + format: int64 source: type: string - enum: [ 'ls', 'url' ] + enum: ["ls", "url", "native"] + + nativeMeta: + type: object + required: + - platform + - platformVersion + - displayName + properties: + platform: + type: string + platformVersion: + type: string + name: + type: string + version: + type: string + displayName: + type: string + build: + type: string + deviceOwnerAuth: + type: string + enum: ["none", "code", "biometrics"] + isBluetoothAvailable: + type: boolean + isBluetoothOn: + type: boolean + isGooglePlayServices: + type: boolean + isDeviceSecure: + type: boolean + error: + type: string clientCapabilities: type: object @@ -2006,16 +2193,16 @@ components: properties: operationType: type: string - enum: [ 'append', 'verify' ] + enum: ["append", "verify"] identifierValue: type: string identifierType: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" ceremonyType: type: string - enum: [ 'local', 'cda', 'security-key' ] + enum: ["local", "cda", "security-key"] aaguidDetails: - $ref: '#/components/schemas/aaguidDetails' + $ref: "#/components/schemas/aaguidDetails" continueOnOtherDevice: type: object @@ -2024,7 +2211,7 @@ components: properties: reason: type: string - enum: [ 'email-link-verified', 'process-already-completed' ] + enum: ["email-link-verified", "process-already-completed"] meRsp: type: object @@ -2041,11 +2228,11 @@ components: identifiers: type: array items: - $ref: '#/components/schemas/identifier' + $ref: "#/components/schemas/identifier" socialAccounts: type: array items: - $ref: '#/components/schemas/socialAccount' + $ref: "#/components/schemas/socialAccount" meUpdateReq: type: object @@ -2068,7 +2255,7 @@ components: value: type: string type: - $ref: '#/components/schemas/loginIdentifierType' + $ref: "#/components/schemas/loginIdentifierType" status: type: string @@ -2081,7 +2268,7 @@ components: - fullName properties: providerType: - $ref: 'common.yml#/components/schemas/socialProviderType' + $ref: "common.yml#/components/schemas/socialProviderType" identifierValue: type: string avatarUrl: @@ -2098,14 +2285,14 @@ components: providers: type: array items: - $ref: 'common.yml#/components/schemas/socialProviderType' + $ref: "common.yml#/components/schemas/socialProviderType" status: type: string - enum: [ 'initial', 'started', 'finished' ] + enum: ["initial", "started", "finished"] oauthUrl: type: string error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" requestError: type: object @@ -2128,16 +2315,16 @@ components: identifier: type: string error: - $ref: '#/components/schemas/requestError' + $ref: "#/components/schemas/requestError" responses: - '200': + "200": description: Operation succeeded content: application/json: schema: - $ref: 'common.yml#/components/schemas/genericRsp' + $ref: "common.yml#/components/schemas/genericRsp" security: - - bearerAuth: [ ] - - projectID: [ ] + - bearerAuth: [] + - projectID: [] diff --git a/packages/web-core/src/api/v2/api.ts b/packages/web-core/src/api/v2/api.ts index bb3504236..154840975 100644 --- a/packages/web-core/src/api/v2/api.ts +++ b/packages/web-core/src/api/v2/api.ts @@ -252,6 +252,12 @@ export interface ClientInformation { * @memberof ClientInformation */ 'clientEnvHandleMeta'?: ClientStateMeta; + /** + * + * @type {NativeMeta} + * @memberof ClientInformation + */ + 'nativeMeta'?: NativeMeta; } /** * @@ -275,7 +281,8 @@ export interface ClientStateMeta { export const ClientStateMetaSourceEnum = { Ls: 'ls', - Url: 'url' + Url: 'url', + Native: 'native' } as const; export type ClientStateMetaSourceEnum = typeof ClientStateMetaSourceEnum[keyof typeof ClientStateMetaSourceEnum]; @@ -373,6 +380,12 @@ export interface ConnectAppendInitRsp { * @memberof ConnectAppendInitRsp */ 'flags': { [key: string]: string; }; + /** + * + * @type {string} + * @memberof ConnectAppendInitRsp + */ + 'newClientState'?: string; } /** * @@ -502,7 +515,7 @@ export interface ConnectLoginFinishRsp { * @type {PasskeyOperation} * @memberof ConnectLoginFinishRsp */ - 'passkeyOperation': PasskeyOperation; + 'passkeyOperation'?: PasskeyOperation; /** * * @type {string} @@ -565,6 +578,12 @@ export interface ConnectLoginInitRsp { * @memberof ConnectLoginInitRsp */ 'newClientEnvHandle'?: string; + /** + * + * @type {string} + * @memberof ConnectLoginInitRsp + */ + 'newClientState'?: string; /** * * @type {number} @@ -673,6 +692,12 @@ export interface ConnectLoginStartRsp { * @memberof ConnectLoginStartRsp */ 'fallbackOperationError': FallbackOperationError; + /** + * + * @type {boolean} + * @memberof ConnectLoginStartRsp + */ + 'preferImmediatelyAvailable'?: boolean; } /** * @@ -1089,7 +1114,8 @@ export interface GeneralBlockPasskeyAppend { export const GeneralBlockPasskeyAppendVariantEnum = { Default: 'default', AfterHybrid: 'after-hybrid', - AfterError: 'after-error' + AfterError: 'after-error', + AfterNoCredential: 'after-no-credential' } as const; export type GeneralBlockPasskeyAppendVariantEnum = typeof GeneralBlockPasskeyAppendVariantEnum[keyof typeof GeneralBlockPasskeyAppendVariantEnum]; @@ -1794,6 +1820,94 @@ export interface MeUpdateReq { */ 'fullName': string; } +/** + * + * @export + * @interface NativeMeta + */ +export interface NativeMeta { + /** + * + * @type {string} + * @memberof NativeMeta + */ + 'platform': string; + /** + * + * @type {string} + * @memberof NativeMeta + */ + 'platformVersion': string; + /** + * + * @type {string} + * @memberof NativeMeta + */ + 'name'?: string; + /** + * + * @type {string} + * @memberof NativeMeta + */ + 'version'?: string; + /** + * + * @type {string} + * @memberof NativeMeta + */ + 'displayName': string; + /** + * + * @type {string} + * @memberof NativeMeta + */ + 'build'?: string; + /** + * + * @type {string} + * @memberof NativeMeta + */ + 'deviceOwnerAuth'?: NativeMetaDeviceOwnerAuthEnum; + /** + * + * @type {boolean} + * @memberof NativeMeta + */ + 'isBluetoothAvailable'?: boolean; + /** + * + * @type {boolean} + * @memberof NativeMeta + */ + 'isBluetoothOn'?: boolean; + /** + * + * @type {boolean} + * @memberof NativeMeta + */ + 'isGooglePlayServices'?: boolean; + /** + * + * @type {boolean} + * @memberof NativeMeta + */ + 'isDeviceSecure'?: boolean; + /** + * + * @type {string} + * @memberof NativeMeta + */ + 'error'?: string; +} + +export const NativeMetaDeviceOwnerAuthEnum = { + None: 'none', + Code: 'code', + Biometrics: 'biometrics' +} as const; + +export type NativeMetaDeviceOwnerAuthEnum = typeof NativeMetaDeviceOwnerAuthEnum[keyof typeof NativeMetaDeviceOwnerAuthEnum]; + /** * * @export @@ -1903,6 +2017,24 @@ export interface Passkey { * @memberof Passkey */ 'aaguidDetails': AaguidDetails; + /** + * Unix timestamp of when the passkey was created (in milliseconds) + * @type {number} + * @memberof Passkey + */ + 'createdMs': number; + /** + * Unix timestamp of when the passkey was last used (in milliseconds) + * @type {number} + * @memberof Passkey + */ + 'lastUsedMs': number; + /** + * Tags attached to a passkey (e.g. synced or hybrid) + * @type {Array} + * @memberof Passkey + */ + 'tags': Array; } export const PasskeyTransportEnum = { @@ -1960,14 +2092,19 @@ export const PasskeyEventType = { LoginErrorUntyped: 'login-error-untyped', LoginErrorUnexpected: 'login-error-unexpected', LoginOneTapSwitch: 'login-one-tap-switch', + LoginNoCredentials: 'login-no-credentials', UserAppendAfterCrossPlatformBlacklisted: 'user-append-after-cross-platform-blacklisted', UserAppendAfterLoginErrorBlacklisted: 'user-append-after-login-error-blacklisted', AppendCredentialExists: 'append-credential-exists', AppendExplicitAbort: 'append-explicit-abort', AppendError: 'append-error', AppendErrorUnexpected: 'append-error-unexpected', + AppendLearnMore: 'append-learn-more', ManageErrorUnexpected: 'manage-error-unexpected', - AppendLearnMore: 'append-learn-more' + ManageError: 'manage-error', + ManageLearnMore: 'manage-learn-more', + ManageCredentialExists: 'manage-credential-exists', + LocalUnlock: 'local-unlock' } as const; export type PasskeyEventType = typeof PasskeyEventType[keyof typeof PasskeyEventType]; @@ -2557,7 +2694,8 @@ export type VerificationMethod = typeof VerificationMethod[keyof typeof Verifica export const AuthApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * tbd + * Skips the current authentication block. + * @summary Skip authentication block * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2594,6 +2732,7 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }, /** * Creates a new user generated complete event. + * @summary Create authentication event * @param {EventCreateReq} eventCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2635,7 +2774,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Updates the user\'s identifier information. + * @summary Update identifier * @param {IdentifierUpdateReq} identifierUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2677,7 +2817,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Completes the identifier verification process. + * @summary Finish identifier verification * @param {IdentifierVerifyFinishReq} identifierVerifyFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2719,7 +2860,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Initiates the identifier verification process. + * @summary Start identifier verification * @param {IdentifierVerifyStartReq} identifierVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2761,7 +2903,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Retrieves the current status of identifier verification. + * @summary Retrieve identifier verification status * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -2797,7 +2940,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Initializes a new login process. + * @summary Initialize login * @param {LoginInitReq} loginInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2839,7 +2983,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Completes the process of appending a new passkey. + * @summary Finish passkey append * @param {PasskeyAppendFinishReq} passkeyAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2881,7 +3026,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Starts the process of appending a new passkey. + * @summary Start passkey append * @param {PasskeyAppendStartReq} passkeyAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2923,7 +3069,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Completes the passkey login process. + * @summary Finish passkey login * @param {PasskeyLoginFinishReq} passkeyLoginFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -2965,7 +3112,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Initiates the passkey login process. + * @summary Start passkey login * @param {PasskeyLoginStartReq} passkeyLoginStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3007,7 +3155,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Completes the passkey mediation process. + * @summary Finish passkey mediation * @param {PasskeyMediationFinishReq} passkeyMediationFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3049,7 +3198,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Completes the current authentication process. + * @summary Complete authentication process * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3085,7 +3235,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Retrieves the current authentication process state. + * @summary Retrieve authentication process * @param {BlockType} [preferredBlock] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3126,7 +3277,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Initializes a new authentication process. + * @summary Initialize authentication process * @param {ProcessInitReq} processInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3168,7 +3320,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Resets the current authentication process. + * @summary Reset authentication process * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3204,7 +3357,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Initializes a new user signup process. + * @summary Initialize signup * @param {SignupInitReq} signupInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3246,7 +3400,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Handles the callback from social authentication providers. + * @summary Social verification callback * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3282,7 +3437,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Completes the social authentication verification process. + * @summary Finish social verification * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3324,7 +3480,8 @@ export const AuthApiAxiosParamCreator = function (configuration?: Configuration) }; }, /** - * tbd + * Initiates the social authentication verification process. + * @summary Start social verification * @param {SocialVerifyStartReq} socialVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3376,7 +3533,8 @@ export const AuthApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AuthApiAxiosParamCreator(configuration) return { /** - * tbd + * Skips the current authentication block. + * @summary Skip authentication block * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3386,6 +3544,7 @@ export const AuthApiFp = function(configuration?: Configuration) { }, /** * Creates a new user generated complete event. + * @summary Create authentication event * @param {EventCreateReq} eventCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3395,7 +3554,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Updates the user\'s identifier information. + * @summary Update identifier * @param {IdentifierUpdateReq} identifierUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3405,7 +3565,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Completes the identifier verification process. + * @summary Finish identifier verification * @param {IdentifierVerifyFinishReq} identifierVerifyFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3415,7 +3576,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Initiates the identifier verification process. + * @summary Start identifier verification * @param {IdentifierVerifyStartReq} identifierVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3425,7 +3587,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Retrieves the current status of identifier verification. + * @summary Retrieve identifier verification status * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3434,7 +3597,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Initializes a new login process. + * @summary Initialize login * @param {LoginInitReq} loginInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3444,7 +3608,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Completes the process of appending a new passkey. + * @summary Finish passkey append * @param {PasskeyAppendFinishReq} passkeyAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3454,7 +3619,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Starts the process of appending a new passkey. + * @summary Start passkey append * @param {PasskeyAppendStartReq} passkeyAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3464,7 +3630,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Completes the passkey login process. + * @summary Finish passkey login * @param {PasskeyLoginFinishReq} passkeyLoginFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3474,7 +3641,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Initiates the passkey login process. + * @summary Start passkey login * @param {PasskeyLoginStartReq} passkeyLoginStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3484,7 +3652,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Completes the passkey mediation process. + * @summary Finish passkey mediation * @param {PasskeyMediationFinishReq} passkeyMediationFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3494,7 +3663,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Completes the current authentication process. + * @summary Complete authentication process * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3503,7 +3673,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Retrieves the current authentication process state. + * @summary Retrieve authentication process * @param {BlockType} [preferredBlock] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3513,7 +3684,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Initializes a new authentication process. + * @summary Initialize authentication process * @param {ProcessInitReq} processInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3523,7 +3695,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Resets the current authentication process. + * @summary Reset authentication process * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3532,7 +3705,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Initializes a new user signup process. + * @summary Initialize signup * @param {SignupInitReq} signupInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3542,7 +3716,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Handles the callback from social authentication providers. + * @summary Social verification callback * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3551,7 +3726,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Completes the social authentication verification process. + * @summary Finish social verification * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3561,7 +3737,8 @@ export const AuthApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * tbd + * Initiates the social authentication verification process. + * @summary Start social verification * @param {SocialVerifyStartReq} socialVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3581,7 +3758,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? const localVarFp = AuthApiFp(configuration) return { /** - * tbd + * Skips the current authentication block. + * @summary Skip authentication block * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3590,6 +3768,7 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? }, /** * Creates a new user generated complete event. + * @summary Create authentication event * @param {EventCreateReq} eventCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3598,7 +3777,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.eventCreate(eventCreateReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Updates the user\'s identifier information. + * @summary Update identifier * @param {IdentifierUpdateReq} identifierUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3607,7 +3787,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.identifierUpdate(identifierUpdateReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Completes the identifier verification process. + * @summary Finish identifier verification * @param {IdentifierVerifyFinishReq} identifierVerifyFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3616,7 +3797,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.identifierVerifyFinish(identifierVerifyFinishReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Initiates the identifier verification process. + * @summary Start identifier verification * @param {IdentifierVerifyStartReq} identifierVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3625,7 +3807,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.identifierVerifyStart(identifierVerifyStartReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Retrieves the current status of identifier verification. + * @summary Retrieve identifier verification status * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3633,7 +3816,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.identifierVerifyStatus(options).then((request) => request(axios, basePath)); }, /** - * tbd + * Initializes a new login process. + * @summary Initialize login * @param {LoginInitReq} loginInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3642,7 +3826,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.loginInit(loginInitReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Completes the process of appending a new passkey. + * @summary Finish passkey append * @param {PasskeyAppendFinishReq} passkeyAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3651,7 +3836,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.passkeyAppendFinish(passkeyAppendFinishReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Starts the process of appending a new passkey. + * @summary Start passkey append * @param {PasskeyAppendStartReq} passkeyAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3660,7 +3846,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.passkeyAppendStart(passkeyAppendStartReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Completes the passkey login process. + * @summary Finish passkey login * @param {PasskeyLoginFinishReq} passkeyLoginFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3669,7 +3856,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.passkeyLoginFinish(passkeyLoginFinishReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Initiates the passkey login process. + * @summary Start passkey login * @param {PasskeyLoginStartReq} passkeyLoginStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3678,7 +3866,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.passkeyLoginStart(passkeyLoginStartReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Completes the passkey mediation process. + * @summary Finish passkey mediation * @param {PasskeyMediationFinishReq} passkeyMediationFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3687,7 +3876,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.passkeyMediationFinish(passkeyMediationFinishReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Completes the current authentication process. + * @summary Complete authentication process * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3695,7 +3885,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.processComplete(options).then((request) => request(axios, basePath)); }, /** - * tbd + * Retrieves the current authentication process state. + * @summary Retrieve authentication process * @param {BlockType} [preferredBlock] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3704,7 +3895,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.processGet(preferredBlock, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Initializes a new authentication process. + * @summary Initialize authentication process * @param {ProcessInitReq} processInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3713,7 +3905,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.processInit(processInitReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Resets the current authentication process. + * @summary Reset authentication process * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3721,7 +3914,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.processReset(options).then((request) => request(axios, basePath)); }, /** - * tbd + * Initializes a new user signup process. + * @summary Initialize signup * @param {SignupInitReq} signupInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3730,7 +3924,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.signupInit(signupInitReq, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Handles the callback from social authentication providers. + * @summary Social verification callback * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -3738,7 +3933,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.socialVerifyCallback(options).then((request) => request(axios, basePath)); }, /** - * tbd + * Completes the social authentication verification process. + * @summary Finish social verification * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3747,7 +3943,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? return localVarFp.socialVerifyFinish(body, options).then((request) => request(axios, basePath)); }, /** - * tbd + * Initiates the social authentication verification process. + * @summary Start social verification * @param {SocialVerifyStartReq} socialVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3766,7 +3963,8 @@ export const AuthApiFactory = function (configuration?: Configuration, basePath? */ export class AuthApi extends BaseAPI { /** - * tbd + * Skips the current authentication block. + * @summary Skip authentication block * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi @@ -3777,6 +3975,7 @@ export class AuthApi extends BaseAPI { /** * Creates a new user generated complete event. + * @summary Create authentication event * @param {EventCreateReq} eventCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3787,7 +3986,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Updates the user\'s identifier information. + * @summary Update identifier * @param {IdentifierUpdateReq} identifierUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3798,7 +3998,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Completes the identifier verification process. + * @summary Finish identifier verification * @param {IdentifierVerifyFinishReq} identifierVerifyFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3809,7 +4010,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Initiates the identifier verification process. + * @summary Start identifier verification * @param {IdentifierVerifyStartReq} identifierVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3820,7 +4022,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Retrieves the current status of identifier verification. + * @summary Retrieve identifier verification status * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi @@ -3830,7 +4033,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Initializes a new login process. + * @summary Initialize login * @param {LoginInitReq} loginInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3841,7 +4045,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Completes the process of appending a new passkey. + * @summary Finish passkey append * @param {PasskeyAppendFinishReq} passkeyAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3852,7 +4057,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Starts the process of appending a new passkey. + * @summary Start passkey append * @param {PasskeyAppendStartReq} passkeyAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3863,7 +4069,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Completes the passkey login process. + * @summary Finish passkey login * @param {PasskeyLoginFinishReq} passkeyLoginFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3874,7 +4081,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Initiates the passkey login process. + * @summary Start passkey login * @param {PasskeyLoginStartReq} passkeyLoginStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3885,7 +4093,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Completes the passkey mediation process. + * @summary Finish passkey mediation * @param {PasskeyMediationFinishReq} passkeyMediationFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3896,7 +4105,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Completes the current authentication process. + * @summary Complete authentication process * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi @@ -3906,7 +4116,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Retrieves the current authentication process state. + * @summary Retrieve authentication process * @param {BlockType} [preferredBlock] * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3917,7 +4128,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Initializes a new authentication process. + * @summary Initialize authentication process * @param {ProcessInitReq} processInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3928,7 +4140,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Resets the current authentication process. + * @summary Reset authentication process * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi @@ -3938,7 +4151,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Initializes a new user signup process. + * @summary Initialize signup * @param {SignupInitReq} signupInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3949,7 +4163,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Handles the callback from social authentication providers. + * @summary Social verification callback * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthApi @@ -3959,7 +4174,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Completes the social authentication verification process. + * @summary Finish social verification * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3970,7 +4186,8 @@ export class AuthApi extends BaseAPI { } /** - * tbd + * Initiates the social authentication verification process. + * @summary Start social verification * @param {SocialVerifyStartReq} socialVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3990,7 +4207,8 @@ export class AuthApi extends BaseAPI { export const ConfigsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * tbd + * Retrieves the session configuration settings. + * @summary Retrieve session configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4026,7 +4244,8 @@ export const ConfigsApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Gets configs needed by the UserDetails component + * Retrieves user details configuration needed by the UserDetails component. + * @summary Retrieve user details configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4072,7 +4291,8 @@ export const ConfigsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = ConfigsApiAxiosParamCreator(configuration) return { /** - * tbd + * Retrieves the session configuration settings. + * @summary Retrieve session configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4081,7 +4301,8 @@ export const ConfigsApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Gets configs needed by the UserDetails component + * Retrieves user details configuration needed by the UserDetails component. + * @summary Retrieve user details configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4100,7 +4321,8 @@ export const ConfigsApiFactory = function (configuration?: Configuration, basePa const localVarFp = ConfigsApiFp(configuration) return { /** - * tbd + * Retrieves the session configuration settings. + * @summary Retrieve session configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4108,7 +4330,8 @@ export const ConfigsApiFactory = function (configuration?: Configuration, basePa return localVarFp.getSessionConfig(options).then((request) => request(axios, basePath)); }, /** - * Gets configs needed by the UserDetails component + * Retrieves user details configuration needed by the UserDetails component. + * @summary Retrieve user details configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -4126,7 +4349,8 @@ export const ConfigsApiFactory = function (configuration?: Configuration, basePa */ export class ConfigsApi extends BaseAPI { /** - * tbd + * Retrieves the session configuration settings. + * @summary Retrieve session configuration * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigsApi @@ -4136,7 +4360,8 @@ export class ConfigsApi extends BaseAPI { } /** - * Gets configs needed by the UserDetails component + * Retrieves user details configuration needed by the UserDetails component. + * @summary Retrieve user details configuration * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigsApi @@ -4155,7 +4380,8 @@ export class ConfigsApi extends BaseAPI { export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Finishes an initialized connect passkey append process. + * Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. + * @summary Finish connect append * @param {ConnectAppendFinishReq} connectAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4197,7 +4423,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Initializes a connect process for passkey append. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey append. + * @summary Initialize connect append * @param {ConnectAppendInitReq} connectAppendInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4239,7 +4466,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Starts an initialized connect passkey append process. + * Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. + * @summary Start connect append * @param {ConnectAppendStartReq} connectAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4281,7 +4509,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Creates a new user generated connect event. + * Creates a new user generated [Corbado Connect](https://docs.corbado.com/corbado-connect) event. + * @summary Create connect event * @param {ConnectEventCreateReq} connectEventCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4323,7 +4552,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Finishes an initialized connect login process. + * Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. + * @summary Finish connect login * @param {ConnectLoginFinishReq} connectLoginFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4365,7 +4595,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Initializes a connect process for login. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for login. + * @summary Initialize connect login * @param {ConnectLoginInitReq} connectLoginInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4407,7 +4638,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Starts an initialized connect login process. + * Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. + * @summary Start connect login * @param {ConnectLoginStartReq} connectLoginStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4449,7 +4681,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Deletes a passkey for a user identified by a connect token + * Deletes a passkey for a user identified by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. + * @summary Delete connect passkey * @param {ConnectManageDeleteReq} connectManageDeleteReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4491,7 +4724,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Initializes a connect process for passkey management. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey management. + * @summary Initialize connect management * @param {ConnectManageInitReq} connectManageInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4533,7 +4767,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Lists all passkeys for a user identifier by a connect token. + * Lists all passkeys for a user identifier by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. + * @summary List connect passkeys * @param {ConnectManageListReq} connectManageListReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4575,7 +4810,8 @@ export const CorbadoConnectApiAxiosParamCreator = function (configuration?: Conf }; }, /** - * Remove process state for a connect process. + * Remove process state for a [Corbado Connect](https://docs.corbado.com/corbado-connect) process. + * @summary Clear connect process * @param {ConnectProcessClearReq} connectProcessClearReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4627,7 +4863,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CorbadoConnectApiAxiosParamCreator(configuration) return { /** - * Finishes an initialized connect passkey append process. + * Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. + * @summary Finish connect append * @param {ConnectAppendFinishReq} connectAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4637,7 +4874,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Initializes a connect process for passkey append. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey append. + * @summary Initialize connect append * @param {ConnectAppendInitReq} connectAppendInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4647,7 +4885,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Starts an initialized connect passkey append process. + * Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. + * @summary Start connect append * @param {ConnectAppendStartReq} connectAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4657,7 +4896,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Creates a new user generated connect event. + * Creates a new user generated [Corbado Connect](https://docs.corbado.com/corbado-connect) event. + * @summary Create connect event * @param {ConnectEventCreateReq} connectEventCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4667,7 +4907,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Finishes an initialized connect login process. + * Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. + * @summary Finish connect login * @param {ConnectLoginFinishReq} connectLoginFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4677,7 +4918,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Initializes a connect process for login. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for login. + * @summary Initialize connect login * @param {ConnectLoginInitReq} connectLoginInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4687,7 +4929,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Starts an initialized connect login process. + * Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. + * @summary Start connect login * @param {ConnectLoginStartReq} connectLoginStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4697,7 +4940,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Deletes a passkey for a user identified by a connect token + * Deletes a passkey for a user identified by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. + * @summary Delete connect passkey * @param {ConnectManageDeleteReq} connectManageDeleteReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4707,7 +4951,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Initializes a connect process for passkey management. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey management. + * @summary Initialize connect management * @param {ConnectManageInitReq} connectManageInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4717,7 +4962,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Lists all passkeys for a user identifier by a connect token. + * Lists all passkeys for a user identifier by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. + * @summary List connect passkeys * @param {ConnectManageListReq} connectManageListReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4727,7 +4973,8 @@ export const CorbadoConnectApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Remove process state for a connect process. + * Remove process state for a [Corbado Connect](https://docs.corbado.com/corbado-connect) process. + * @summary Clear connect process * @param {ConnectProcessClearReq} connectProcessClearReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4747,7 +4994,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, const localVarFp = CorbadoConnectApiFp(configuration) return { /** - * Finishes an initialized connect passkey append process. + * Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. + * @summary Finish connect append * @param {ConnectAppendFinishReq} connectAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4756,7 +5004,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectAppendFinish(connectAppendFinishReq, options).then((request) => request(axios, basePath)); }, /** - * Initializes a connect process for passkey append. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey append. + * @summary Initialize connect append * @param {ConnectAppendInitReq} connectAppendInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4765,7 +5014,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectAppendInit(connectAppendInitReq, options).then((request) => request(axios, basePath)); }, /** - * Starts an initialized connect passkey append process. + * Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. + * @summary Start connect append * @param {ConnectAppendStartReq} connectAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4774,7 +5024,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectAppendStart(connectAppendStartReq, options).then((request) => request(axios, basePath)); }, /** - * Creates a new user generated connect event. + * Creates a new user generated [Corbado Connect](https://docs.corbado.com/corbado-connect) event. + * @summary Create connect event * @param {ConnectEventCreateReq} connectEventCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4783,7 +5034,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectEventCreate(connectEventCreateReq, options).then((request) => request(axios, basePath)); }, /** - * Finishes an initialized connect login process. + * Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. + * @summary Finish connect login * @param {ConnectLoginFinishReq} connectLoginFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4792,7 +5044,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectLoginFinish(connectLoginFinishReq, options).then((request) => request(axios, basePath)); }, /** - * Initializes a connect process for login. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for login. + * @summary Initialize connect login * @param {ConnectLoginInitReq} connectLoginInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4801,7 +5054,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectLoginInit(connectLoginInitReq, options).then((request) => request(axios, basePath)); }, /** - * Starts an initialized connect login process. + * Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. + * @summary Start connect login * @param {ConnectLoginStartReq} connectLoginStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4810,7 +5064,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectLoginStart(connectLoginStartReq, options).then((request) => request(axios, basePath)); }, /** - * Deletes a passkey for a user identified by a connect token + * Deletes a passkey for a user identified by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. + * @summary Delete connect passkey * @param {ConnectManageDeleteReq} connectManageDeleteReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4819,7 +5074,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectManageDelete(connectManageDeleteReq, options).then((request) => request(axios, basePath)); }, /** - * Initializes a connect process for passkey management. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey management. + * @summary Initialize connect management * @param {ConnectManageInitReq} connectManageInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4828,7 +5084,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectManageInit(connectManageInitReq, options).then((request) => request(axios, basePath)); }, /** - * Lists all passkeys for a user identifier by a connect token. + * Lists all passkeys for a user identifier by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. + * @summary List connect passkeys * @param {ConnectManageListReq} connectManageListReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4837,7 +5094,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, return localVarFp.connectManageList(connectManageListReq, options).then((request) => request(axios, basePath)); }, /** - * Remove process state for a connect process. + * Remove process state for a [Corbado Connect](https://docs.corbado.com/corbado-connect) process. + * @summary Clear connect process * @param {ConnectProcessClearReq} connectProcessClearReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4856,7 +5114,8 @@ export const CorbadoConnectApiFactory = function (configuration?: Configuration, */ export class CorbadoConnectApi extends BaseAPI { /** - * Finishes an initialized connect passkey append process. + * Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. + * @summary Finish connect append * @param {ConnectAppendFinishReq} connectAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4867,7 +5126,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Initializes a connect process for passkey append. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey append. + * @summary Initialize connect append * @param {ConnectAppendInitReq} connectAppendInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4878,7 +5138,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Starts an initialized connect passkey append process. + * Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) passkey append process. + * @summary Start connect append * @param {ConnectAppendStartReq} connectAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4889,7 +5150,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Creates a new user generated connect event. + * Creates a new user generated [Corbado Connect](https://docs.corbado.com/corbado-connect) event. + * @summary Create connect event * @param {ConnectEventCreateReq} connectEventCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4900,7 +5162,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Finishes an initialized connect login process. + * Finishes an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. + * @summary Finish connect login * @param {ConnectLoginFinishReq} connectLoginFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4911,7 +5174,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Initializes a connect process for login. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for login. + * @summary Initialize connect login * @param {ConnectLoginInitReq} connectLoginInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4922,7 +5186,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Starts an initialized connect login process. + * Starts an initialized [Corbado Connect](https://docs.corbado.com/corbado-connect) login process. + * @summary Start connect login * @param {ConnectLoginStartReq} connectLoginStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4933,7 +5198,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Deletes a passkey for a user identified by a connect token + * Deletes a passkey for a user identified by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. + * @summary Delete connect passkey * @param {ConnectManageDeleteReq} connectManageDeleteReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4944,7 +5210,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Initializes a connect process for passkey management. + * Initializes a [Corbado Connect](https://docs.corbado.com/corbado-connect) process for passkey management. + * @summary Initialize connect management * @param {ConnectManageInitReq} connectManageInitReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4955,7 +5222,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Lists all passkeys for a user identifier by a connect token. + * Lists all passkeys for a user identifier by a [Corbado Connect](https://docs.corbado.com/corbado-connect) token. + * @summary List connect passkeys * @param {ConnectManageListReq} connectManageListReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4966,7 +5234,8 @@ export class CorbadoConnectApi extends BaseAPI { } /** - * Remove process state for a connect process. + * Remove process state for a [Corbado Connect](https://docs.corbado.com/corbado-connect) process. + * @summary Clear connect process * @param {ConnectProcessClearReq} connectProcessClearReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4986,7 +5255,8 @@ export class CorbadoConnectApi extends BaseAPI { export const UsersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Deletes current user + * Deletes currently logged in user. + * @summary Delete current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5022,7 +5292,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Gets current user + * Retrieves data of currently logged in user including their [login identifiers](/api-reference/backend-api/loginidentifiers/create-a-login-identifier-for-a-user) and [social logins](/api-reference/backend-api/users/create-a-social-login-for-a-user). + * @summary Retrieve current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5058,7 +5329,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Creates an identifier + * Creates a login identifier for the currently logged in user. + * @summary Create login identifier * @param {MeIdentifierCreateReq} meIdentifierCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5100,7 +5372,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Deletes an identifier + * Deletes a login identifier for the currently logged in user. + * @summary Delete login identifier * @param {MeIdentifierDeleteReq} meIdentifierDeleteReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5142,7 +5415,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Modifies an identifier (only permitted for username; identifierID will change) + * Updates a login identifier for the currently logged in user. + * @summary Update login identifier * @param {MeIdentifierUpdateReq} meIdentifierUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5184,7 +5458,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Verifies challenge + * Finishes login identifer verification of currently logged in user. + * @summary Finish login identifier verification * @param {MeIdentifierVerifyFinishReq} meIdentifierVerifyFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5226,7 +5501,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Creates challenge (only email otp and phone otp supported for now) + * Starts login identifer verification of currently logged in user. + * @summary Start login identifier verification * @param {MeIdentifierVerifyStartReq} meIdentifierVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5268,7 +5544,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Finishes passkey append for current user + * Finishes passkey append for currently logged in user. + * @summary Finish passkey append * @param {MePasskeysAppendFinishReq} mePasskeysAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5310,7 +5587,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Starts passkey append for current user + * Starts passkey append for currently logged in user. + * @summary Start passkey append * @param {MePasskeysAppendStartReq} mePasskeysAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5352,8 +5630,9 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Delete current user\'s passkeys - * @param {string} credentialID Credential ID from passkeys + * Deletes a passkey for the currently logged in user. + * @summary Delete user passkey + * @param {string} credentialID Unique identifier of the passkey. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5392,7 +5671,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Gets current user\'s passkeys + * Returns a list of passkeys for the currently logged in user. + * @summary List all user passkeys * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5428,7 +5708,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Performs session logout + * Performs session logout of currently logged in user. Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. + * @summary Logout user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5464,7 +5745,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Performs session refresh + * Performs session refresh of currently logged in user. Issues a new session-token if session is still valid. Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. + * @summary Refresh user session * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5500,7 +5782,8 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration }; }, /** - * Updates current user + * Updates data of currently logged in user. + * @summary Update current User * @param {MeUpdateReq} meUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5552,7 +5835,8 @@ export const UsersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = UsersApiAxiosParamCreator(configuration) return { /** - * Deletes current user + * Deletes currently logged in user. + * @summary Delete current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5561,7 +5845,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Gets current user + * Retrieves data of currently logged in user including their [login identifiers](/api-reference/backend-api/loginidentifiers/create-a-login-identifier-for-a-user) and [social logins](/api-reference/backend-api/users/create-a-social-login-for-a-user). + * @summary Retrieve current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5570,7 +5855,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Creates an identifier + * Creates a login identifier for the currently logged in user. + * @summary Create login identifier * @param {MeIdentifierCreateReq} meIdentifierCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5580,7 +5866,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Deletes an identifier + * Deletes a login identifier for the currently logged in user. + * @summary Delete login identifier * @param {MeIdentifierDeleteReq} meIdentifierDeleteReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5590,7 +5877,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Modifies an identifier (only permitted for username; identifierID will change) + * Updates a login identifier for the currently logged in user. + * @summary Update login identifier * @param {MeIdentifierUpdateReq} meIdentifierUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5600,7 +5888,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Verifies challenge + * Finishes login identifer verification of currently logged in user. + * @summary Finish login identifier verification * @param {MeIdentifierVerifyFinishReq} meIdentifierVerifyFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5610,7 +5899,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Creates challenge (only email otp and phone otp supported for now) + * Starts login identifer verification of currently logged in user. + * @summary Start login identifier verification * @param {MeIdentifierVerifyStartReq} meIdentifierVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5620,7 +5910,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Finishes passkey append for current user + * Finishes passkey append for currently logged in user. + * @summary Finish passkey append * @param {MePasskeysAppendFinishReq} mePasskeysAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5630,7 +5921,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Starts passkey append for current user + * Starts passkey append for currently logged in user. + * @summary Start passkey append * @param {MePasskeysAppendStartReq} mePasskeysAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5640,8 +5932,9 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Delete current user\'s passkeys - * @param {string} credentialID Credential ID from passkeys + * Deletes a passkey for the currently logged in user. + * @summary Delete user passkey + * @param {string} credentialID Unique identifier of the passkey. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5650,7 +5943,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Gets current user\'s passkeys + * Returns a list of passkeys for the currently logged in user. + * @summary List all user passkeys * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5659,7 +5953,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Performs session logout + * Performs session logout of currently logged in user. Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. + * @summary Logout user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5668,7 +5963,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Performs session refresh + * Performs session refresh of currently logged in user. Issues a new session-token if session is still valid. Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. + * @summary Refresh user session * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5677,7 +5973,8 @@ export const UsersApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Updates current user + * Updates data of currently logged in user. + * @summary Update current User * @param {MeUpdateReq} meUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5697,7 +5994,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath const localVarFp = UsersApiFp(configuration) return { /** - * Deletes current user + * Deletes currently logged in user. + * @summary Delete current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5705,7 +6003,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserDelete(options).then((request) => request(axios, basePath)); }, /** - * Gets current user + * Retrieves data of currently logged in user including their [login identifiers](/api-reference/backend-api/loginidentifiers/create-a-login-identifier-for-a-user) and [social logins](/api-reference/backend-api/users/create-a-social-login-for-a-user). + * @summary Retrieve current user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5713,7 +6012,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserGet(options).then((request) => request(axios, basePath)); }, /** - * Creates an identifier + * Creates a login identifier for the currently logged in user. + * @summary Create login identifier * @param {MeIdentifierCreateReq} meIdentifierCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5722,7 +6022,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserIdentifierCreate(meIdentifierCreateReq, options).then((request) => request(axios, basePath)); }, /** - * Deletes an identifier + * Deletes a login identifier for the currently logged in user. + * @summary Delete login identifier * @param {MeIdentifierDeleteReq} meIdentifierDeleteReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5731,7 +6032,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserIdentifierDelete(meIdentifierDeleteReq, options).then((request) => request(axios, basePath)); }, /** - * Modifies an identifier (only permitted for username; identifierID will change) + * Updates a login identifier for the currently logged in user. + * @summary Update login identifier * @param {MeIdentifierUpdateReq} meIdentifierUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5740,7 +6042,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserIdentifierUpdate(meIdentifierUpdateReq, options).then((request) => request(axios, basePath)); }, /** - * Verifies challenge + * Finishes login identifer verification of currently logged in user. + * @summary Finish login identifier verification * @param {MeIdentifierVerifyFinishReq} meIdentifierVerifyFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5749,7 +6052,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserIdentifierVerifyFinish(meIdentifierVerifyFinishReq, options).then((request) => request(axios, basePath)); }, /** - * Creates challenge (only email otp and phone otp supported for now) + * Starts login identifer verification of currently logged in user. + * @summary Start login identifier verification * @param {MeIdentifierVerifyStartReq} meIdentifierVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5758,7 +6062,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserIdentifierVerifyStart(meIdentifierVerifyStartReq, options).then((request) => request(axios, basePath)); }, /** - * Finishes passkey append for current user + * Finishes passkey append for currently logged in user. + * @summary Finish passkey append * @param {MePasskeysAppendFinishReq} mePasskeysAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5767,7 +6072,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserPasskeyAppendFinish(mePasskeysAppendFinishReq, options).then((request) => request(axios, basePath)); }, /** - * Starts passkey append for current user + * Starts passkey append for currently logged in user. + * @summary Start passkey append * @param {MePasskeysAppendStartReq} mePasskeysAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5776,8 +6082,9 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserPasskeyAppendStart(mePasskeysAppendStartReq, options).then((request) => request(axios, basePath)); }, /** - * Delete current user\'s passkeys - * @param {string} credentialID Credential ID from passkeys + * Deletes a passkey for the currently logged in user. + * @summary Delete user passkey + * @param {string} credentialID Unique identifier of the passkey. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5785,7 +6092,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserPasskeyDelete(credentialID, options).then((request) => request(axios, basePath)); }, /** - * Gets current user\'s passkeys + * Returns a list of passkeys for the currently logged in user. + * @summary List all user passkeys * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5793,7 +6101,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserPasskeyGet(options).then((request) => request(axios, basePath)); }, /** - * Performs session logout + * Performs session logout of currently logged in user. Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. + * @summary Logout user * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5801,7 +6110,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserSessionLogout(options).then((request) => request(axios, basePath)); }, /** - * Performs session refresh + * Performs session refresh of currently logged in user. Issues a new session-token if session is still valid. Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. + * @summary Refresh user session * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5809,7 +6119,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath return localVarFp.currentUserSessionRefresh(options).then((request) => request(axios, basePath)); }, /** - * Updates current user + * Updates data of currently logged in user. + * @summary Update current User * @param {MeUpdateReq} meUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5828,7 +6139,8 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath */ export class UsersApi extends BaseAPI { /** - * Deletes current user + * Deletes currently logged in user. + * @summary Delete current user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi @@ -5838,7 +6150,8 @@ export class UsersApi extends BaseAPI { } /** - * Gets current user + * Retrieves data of currently logged in user including their [login identifiers](/api-reference/backend-api/loginidentifiers/create-a-login-identifier-for-a-user) and [social logins](/api-reference/backend-api/users/create-a-social-login-for-a-user). + * @summary Retrieve current user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi @@ -5848,7 +6161,8 @@ export class UsersApi extends BaseAPI { } /** - * Creates an identifier + * Creates a login identifier for the currently logged in user. + * @summary Create login identifier * @param {MeIdentifierCreateReq} meIdentifierCreateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5859,7 +6173,8 @@ export class UsersApi extends BaseAPI { } /** - * Deletes an identifier + * Deletes a login identifier for the currently logged in user. + * @summary Delete login identifier * @param {MeIdentifierDeleteReq} meIdentifierDeleteReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5870,7 +6185,8 @@ export class UsersApi extends BaseAPI { } /** - * Modifies an identifier (only permitted for username; identifierID will change) + * Updates a login identifier for the currently logged in user. + * @summary Update login identifier * @param {MeIdentifierUpdateReq} meIdentifierUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5881,7 +6197,8 @@ export class UsersApi extends BaseAPI { } /** - * Verifies challenge + * Finishes login identifer verification of currently logged in user. + * @summary Finish login identifier verification * @param {MeIdentifierVerifyFinishReq} meIdentifierVerifyFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5892,7 +6209,8 @@ export class UsersApi extends BaseAPI { } /** - * Creates challenge (only email otp and phone otp supported for now) + * Starts login identifer verification of currently logged in user. + * @summary Start login identifier verification * @param {MeIdentifierVerifyStartReq} meIdentifierVerifyStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5903,7 +6221,8 @@ export class UsersApi extends BaseAPI { } /** - * Finishes passkey append for current user + * Finishes passkey append for currently logged in user. + * @summary Finish passkey append * @param {MePasskeysAppendFinishReq} mePasskeysAppendFinishReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5914,7 +6233,8 @@ export class UsersApi extends BaseAPI { } /** - * Starts passkey append for current user + * Starts passkey append for currently logged in user. + * @summary Start passkey append * @param {MePasskeysAppendStartReq} mePasskeysAppendStartReq * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -5925,8 +6245,9 @@ export class UsersApi extends BaseAPI { } /** - * Delete current user\'s passkeys - * @param {string} credentialID Credential ID from passkeys + * Deletes a passkey for the currently logged in user. + * @summary Delete user passkey + * @param {string} credentialID Unique identifier of the passkey. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi @@ -5936,7 +6257,8 @@ export class UsersApi extends BaseAPI { } /** - * Gets current user\'s passkeys + * Returns a list of passkeys for the currently logged in user. + * @summary List all user passkeys * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi @@ -5946,7 +6268,8 @@ export class UsersApi extends BaseAPI { } /** - * Performs session logout + * Performs session logout of currently logged in user. Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. + * @summary Logout user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi @@ -5956,7 +6279,8 @@ export class UsersApi extends BaseAPI { } /** - * Performs session refresh + * Performs session refresh of currently logged in user. Issues a new session-token if session is still valid. Manage users sessions in the [Developer Panel](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. + * @summary Refresh user session * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi @@ -5966,7 +6290,8 @@ export class UsersApi extends BaseAPI { } /** - * Updates current user + * Updates data of currently logged in user. + * @summary Update current User * @param {MeUpdateReq} meUpdateReq * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/packages/web-core/src/api/v2/base.ts b/packages/web-core/src/api/v2/base.ts index 2f2399c45..883001f7c 100644 --- a/packages/web-core/src/api/v2/base.ts +++ b/packages/web-core/src/api/v2/base.ts @@ -19,7 +19,7 @@ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://.frontendapi.corbado.io".replace(/\/+$/, ""); +export const BASE_PATH = "https://pro-000000.frontendapi.corbado.io".replace(/\/+$/, ""); /** * diff --git a/packages/web-core/src/services/ConnectService.ts b/packages/web-core/src/services/ConnectService.ts index 930d07e4b..5bbaf2c5c 100644 --- a/packages/web-core/src/services/ConnectService.ts +++ b/packages/web-core/src/services/ConnectService.ts @@ -201,6 +201,10 @@ export class ConnectService { ClientStateService.setClientEnvHandle(this.#projectId, res.val.newClientEnvHandle); } + if (res.val.newClientState) { + ClientStateService.enrichFromURL(this.#projectId, res.val.newClientState); + } + flags.addItemsObject(res.val.flags); const loginData: ConnectLoginInitData = { @@ -368,6 +372,10 @@ export class ConnectService { ClientStateService.setClientEnvHandle(this.#projectId, res.val.newClientEnvHandle); } + if (res.val.newClientState) { + ClientStateService.enrichFromURL(this.#projectId, res.val.newClientState); + } + flags.addItemsObject(res.val.flags); const appendData: ConnectAppendInitData = {