openapi: 3.1.1 info: version: 2.0.0 title: Corbado Backend API description: | # Introduction This documentation gives an overview of all Corbado Backend API calls to implement passwordless authentication with Passkeys. contact: name: Corbado team email: support@corbado.com url: https://www.corbado.com servers: - url: https://backendapi.cloud.corbado.io/v2 tags: - name: ConnectTokens description: All API calls to manage connectTokens x-group: Connect tokens - name: Passkeys description: All API calls for passkey flows x-group: Passkey ceremonies - name: Users description: All API calls to manage users x-group: Users and passkeys - name: Identifiers description: All API calls to manage login identifiers x-group: Identifiers - name: PasskeyEvents description: All API calls to manage passkey events x-group: Passkey diagnostics - name: PasskeyChallenges description: All API calls to manage passkey challenges x-group: Passkey diagnostics - name: Exports description: All API calls to manage project export files x-group: Data exports - name: Connect reads description: Connect analytics, process investigation and configuration reads. x-group: Analytics and configuration - name: ConnectManagement description: Connect application and native-app configuration management. x-group: App configuration - name: ConnectRollout description: Connect rollout configuration, rulesets, targeting and simulations. x-group: Rollout configuration - name: Sessions description: All API calls to manage sessions - name: Challenges description: All API calls to manage challenges - name: SSO description: All API calls for SSO flows - name: AuthEvents description: All API calls to manage authentication events - name: ProjectConfig description: All API calls to manage project configurations - name: WebhookEndpoints description: All API calls to manage webhook endpoints - name: PasswordManagers description: All API calls to manage password managers - name: ClientEnvs description: All API calls to manage client environments - name: Devices description: All API calls to manage devices paths: /users: post: x-mint: href: /api-reference/connect/backend/users/create-a-new-user summary: Create a new user description: |- Creates a new user with the given status. Use [login identifiers](/api-reference/connect/backend/identifiers/create-a-login-identifier-for-a-user) to add an email address or phone number to the user. You can also manage users in the [Management Console](https://app.corbado.com/users). Required API key permission: `users:write`. operationId: UserCreate tags: - Users security: - basicAuth: [] - bearerAuth: - users:write requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/userCreateReq" responses: "200": description: User has been created. content: application/json: schema: $ref: "#/components/schemas/user" default: $ref: "#/components/responses/error" get: x-mint: href: /api-reference/connect/backend/users/list-users summary: List users description: |- Lists project users with pagination. Sort by creation time using `created` (ascending) or `-created` (descending). Use exactly one filter: `userID`, `userIDs`, `webauthnIDs`, `identifierValue` or `identifierValues`. Identifier filters require `identifierType`. List filters accept at most 1,000 values. Required API key permission: `users:read`. operationId: UserList tags: - Users security: - basicAuth: [] - bearerAuth: - users:read parameters: - name: userID in: query description: Filter by specific user ID (format `usr-`). Cannot be used together with `userIDs`. required: false schema: type: string example: "usr-4693224802260150919" - name: userIDs in: query description: Filter by multiple user IDs (comma-separated). Cannot be used together with `userID`, `webauthnIDs`, or identifier filters. Maximum 1000 IDs. required: false schema: type: array items: type: string example: ["usr-4693224802260150919", "usr-1234567890123456789"] style: form explode: false - name: userIDPattern in: query description: Filter by user IDs matching the given pattern. Supports `%` as a wildcard character. Cannot be used together with other filter types. required: false schema: type: string example: "usr-%" - name: webauthnIDs in: query description: Filter by multiple WebAuthn IDs (comma-separated). Cannot be used together with other filter types. Maximum 1000 IDs. required: false schema: type: array items: type: string example: ["abc123def456", "xyz789ghi012"] style: form explode: false - name: identifierValue in: query description: Filter by identifier value (email, phone, or username). Must be used together with `identifierType`. Cannot be used together with `identifierValues`. required: false schema: type: string example: "jane@doe.com" - name: identifierValues in: query description: Filter by multiple identifier values (comma-separated). Must be used together with `identifierType`. Cannot be used together with `identifierValue`. Maximum 1000 values. required: false schema: type: array items: type: string example: ["jane@doe.com", "john@example.com"] style: form explode: false - name: identifierType in: query description: Type of identifier to filter by. Must be used together with `identifierValue` or `identifierValues`. required: false schema: type: string enum: - "email" - "phone" - "username" example: "email" - name: status in: query description: Filter by user status. required: false schema: type: string enum: - "active" - "pending" - "disabled" - "deleted" example: "active" - name: sort in: query description: | Sort field. Only `created` is supported. - Use `+created` for ascending order - Use `-created` for descending order required: false schema: type: string enum: - "+created" - "-created" example: "-created" - name: includeIdentifiers in: query description: Whether to include login identifiers in the response. Defaults to `true`. required: false schema: type: boolean default: true - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 responses: "200": description: List of users. content: application/json: schema: $ref: "#/components/schemas/userList" default: $ref: "#/components/responses/error" /users/{userID}: get: x-mint: href: /api-reference/connect/backend/users/retrieve-a-user summary: Retrieve a user description: |- Retrieves a user by given `userID`. This does not return login identifiers like email addresses or phone numbers. You can also manage users in the [Management Console](https://app.corbado.com/users). Required API key permission: `users:read`. operationId: UserGet tags: - Users security: - basicAuth: [] - bearerAuth: - users:read parameters: - $ref: "#/components/parameters/userID" responses: "200": description: User has been returned. content: application/json: schema: $ref: "#/components/schemas/user" default: $ref: "#/components/responses/error" patch: x-mint: href: /api-reference/connect/backend/users/update-a-user summary: Update a user description: |- Updates a user by given `userID`. For example, this can be used to modify the user's status. You can also manage users in the [Management Console](https://app.corbado.com/users). Required API key permission: `users:write`. operationId: UserUpdate tags: - Users security: - basicAuth: [] - bearerAuth: - users:write parameters: - $ref: "#/components/parameters/userID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/userUpdateReq" responses: "200": description: User has been updated. content: application/json: schema: $ref: "#/components/schemas/user" default: $ref: "#/components/responses/error" delete: x-mint: href: /api-reference/connect/backend/users/delete-a-user summary: Delete a user description: |- Deletes a user by given `userID`. You can also manage users in the [Management Console](https://app.corbado.com/users). Deletes the user record in your Connect project. Coordinate account and session changes with your own identity system. This is separate from Observe user-data deletion. Required API key permission: `users:write`. operationId: UserDelete tags: - Users security: - basicAuth: [] - bearerAuth: - users:write parameters: - $ref: "#/components/parameters/userID" responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" /users/{userID}/challenges: post: x-excluded: true summary: Create a challenge for a user description: | Creates a new challenge to verify a login identifier for a user by given `userID`. Challenges come in three flavors: **Email OTP**, **SMS OTP**, and **Email Magiclink**. **OTP** stands for One-Time Password. It is a unique code sent to the user via email or SMS, which they must enter to complete the verification process. operationId: ChallengeCreate tags: - Challenges security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/userID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/challengeCreateReq" responses: "200": description: Challenge has been created. content: application/json: schema: $ref: "#/components/schemas/challenge" default: $ref: "#/components/responses/error" /users/{userID}/challenges/{challengeID}: patch: x-excluded: true summary: Update a challenge for a user description: | Updates a challenge for a user by given `userID` and `challengeID`. For example, this can be used to change the challenge status from `pending` to `completed`. operationId: ChallengeUpdate tags: - Challenges security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/userID" - $ref: "#/components/parameters/challengeID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/challengeUpdateReq" responses: "200": description: Challenge has been updated. content: application/json: schema: $ref: "#/components/schemas/challenge" default: $ref: "#/components/responses/error" /users/{userID}/identifiers: post: x-mint: href: /api-reference/connect/backend/identifiers/create-a-login-identifier-for-a-user summary: Create a login identifier for a user description: |- Adds an `email`, `phone` or `username` login identifier to a user. A user can have multiple identifiers. Connect uses username identifiers to [map your external identity](/corbado-connect/concepts/connect-token) to the Corbado user and passkeys. This operation does not create an identity-provider session. Required API key permission: `identifiers:write`. operationId: IdentifierCreate tags: - Identifiers security: - basicAuth: [] - bearerAuth: - identifiers:write parameters: - $ref: "#/components/parameters/userID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/identifierCreateReq" responses: "200": description: Identifier has been created. content: application/json: schema: $ref: "#/components/schemas/identifier" default: $ref: "#/components/responses/error" /users/{userID}/identifiers/{identifierID}: delete: x-mint: href: /api-reference/connect/backend/identifiers/delete-a-login-identifier-for-a-user summary: Delete a login identifier for a user description: |- Delete an existing login identifier for a user by given `userID` and `identifierID`. Required API key permission: `identifiers:write`. operationId: IdentifierDelete tags: - Identifiers security: - basicAuth: [] - bearerAuth: - identifiers:write parameters: - $ref: "#/components/parameters/userID" - $ref: "#/components/parameters/identifierID" responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" patch: x-mint: href: /api-reference/connect/backend/identifiers/update-a-login-identifier-for-a-user summary: Update a login identifier for a user description: |- Updates a login identifier (e.g. from `pending` to `verified`) for a user by given `userID` and `identifierID`. Required API key permission: `identifiers:write`. operationId: IdentifierUpdate tags: - Identifiers security: - basicAuth: [] - bearerAuth: - identifiers:write parameters: - $ref: "#/components/parameters/userID" - $ref: "#/components/parameters/identifierID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/identifierUpdateReq" responses: "200": description: Identifier has been updated. content: application/json: schema: $ref: "#/components/schemas/identifier" default: $ref: "#/components/responses/error" /users/{userID}/socialAccounts: get: x-excluded: true summary: List all social logins for a user description: | Returns a list of social logins for a user by given `userID`. The list can be sorted and filtered: - The `sort` parameter supports the following fields: `providerType` and `foreignID`. - The `filter` parameter supports the following fields: `providerType` and `foreignID`. Refer to the parameter description for more details on sorting in different directions and using the filter with different operators. operationId: UserSocialAccountList tags: - Users security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/userID" - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 responses: "200": description: List of social logins. content: application/json: schema: type: array items: $ref: "#/components/schemas/socialAccount" default: $ref: "#/components/responses/error" post: x-excluded: true summary: Create a social login for a user description: | Creates a new social login for a user by given `userID`. Social logins are used to authenticate users with third-party providers like Google, Microsoft, or GitHub. You can set up social logins in the [Management Console](https://app.corbado.com/settings/userinterface?tab=Social) or consult the [Documentation](/corbado-complete/overview/configuration/social-logins/overview) for more details. operationId: SocialAccountCreate tags: - Users security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/userID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/socialAccountCreateReq" responses: "200": description: Social login has been created. content: application/json: schema: $ref: "#/components/schemas/socialAccount" default: $ref: "#/components/responses/error" /users/{userID}/credentials: get: x-mint: href: /api-reference/connect/backend/users/list-passkeys-for-a-user summary: List passkeys for a user description: |- Lists a user's passkeys. Both `sort` and `filter` support `userID`, `created`, `status`, `backupState`, `browserName` and `osName`. See the parameters for sort directions and filter operators. Required API key permission: `credentials:read`. operationId: CredentialList tags: - Users security: - basicAuth: [] - bearerAuth: - credentials:read parameters: - $ref: "#/components/parameters/userID" - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 - $ref: "#/components/parameters/includeAllStatus" responses: "200": description: List of passkeys. content: application/json: schema: $ref: "#/components/schemas/credentialList" default: $ref: "#/components/responses/error" /users/{userID}/credentials/{credentialID}: delete: x-mint: href: /api-reference/connect/backend/users/delete-a-passkey-for-a-user summary: Delete a passkey for a user description: |- Deletes an existing passkey for a user by given `userID` and `credentialID`. Required API key permission: `credentials:delete`. operationId: CredentialDelete tags: - Users security: - basicAuth: [] - bearerAuth: - credentials:delete parameters: - $ref: "#/components/parameters/userID" - $ref: "#/components/parameters/credentialID" responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" /users/{userID}/fullCredentials: get: x-mint: href: /api-reference/connect/backend/users/list-passkeys-for-a-user-including-full-authenticator-data summary: List passkeys for a user including full authenticator data description: |- Returns a list of passkeys for a user by given `userID`, including the full authenticator data (`publicKey`, `authenticatorSignCount` and `authenticatorAttachment`) which is not part of [List passkeys for a user](/api-reference/connect/backend/users/list-passkeys-for-a-user). Required API key permission: `credentials:export`. operationId: FullCredentialList tags: - Users security: - basicAuth: [] - bearerAuth: - credentials:export parameters: - $ref: "#/components/parameters/userID" responses: "200": description: List of passkeys including full authenticator data. content: application/json: schema: $ref: "#/components/schemas/fullCredentialList" default: $ref: "#/components/responses/error" /users/{userID}/authEvents: post: summary: "Create an authentication event" description: Create a new authentication event for a user operationId: AuthEventCreate x-excluded: true tags: - AuthEvents security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/userID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/authEventCreateReq" responses: "200": description: Auth event has been created. content: application/json: schema: $ref: "#/components/schemas/authEvent" default: $ref: "#/components/responses/error" /users/{userID}/passkeyEvents: post: x-mint: href: /api-reference/connect/backend/passkeyevents/create-a-passkey-event-for-a-user summary: Create a passkey event for a user description: |- Creates a new passkey event for a user by given `userID`. Required API key permission: `passkey_events:write`. operationId: PasskeyEventCreate tags: - PasskeyEvents security: - basicAuth: [] - bearerAuth: - passkey_events:write parameters: - $ref: "#/components/parameters/userID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyEventCreateReq" responses: "200": description: Passkey event has been created. content: application/json: schema: $ref: "#/components/schemas/passkeyEvent" default: $ref: "#/components/responses/error" get: x-mint: href: /api-reference/connect/backend/passkeyevents/list-all-passkey-events-for-a-user summary: List all passkey events for a user description: |- Lists a user's passkey events. Sort by `created` or `eventType` and filter by `eventType`. See the parameters for sort directions and filter operators. Required API key permission: `passkey_events:read`. operationId: PasskeyEventList tags: - PasskeyEvents security: - basicAuth: [] - bearerAuth: - passkey_events:read parameters: - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 - $ref: "#/components/parameters/userID" responses: "200": description: List of all matching passkey events. content: application/json: schema: $ref: "#/components/schemas/passkeyEventList" default: $ref: "#/components/responses/error" /users/{userID}/passkeyEvents/{passkeyEventID}: delete: x-mint: href: /api-reference/connect/backend/passkeyevents/delete-a-passkey-event-for-a-user summary: Delete a passkey event for a user description: |- Deletes an existing passkey event for a user by given `userID` and `passkeyEventID`. Required API key permission: `passkey_events:write`. operationId: PasskeyEventDelete tags: - PasskeyEvents security: - basicAuth: [] - bearerAuth: - passkey_events:write parameters: - $ref: "#/components/parameters/userID" - $ref: "#/components/parameters/passkeyEventID" responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" /users/{userID}/passkeyChallenges: get: x-mint: href: /api-reference/connect/backend/passkeychallenges/list-all-passkey-challenges-for-a-user summary: List all passkey challenges for a user description: |- Lists a user's passkey challenges. Both `sort` and `filter` support `userID`, `projectID`, `status` and `type`. See the parameters for sort directions and filter operators. Required API key permission: `passkey_challenges:read`. operationId: PasskeyChallengeList tags: - PasskeyChallenges security: - basicAuth: [] - bearerAuth: - passkey_challenges:read parameters: - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 - $ref: "#/components/parameters/userID" responses: "200": description: List of all matching passkey challenges. content: application/json: schema: $ref: "#/components/schemas/passkeyChallengeList" default: $ref: "#/components/responses/error" /users/{userID}/passkeyChallenges/{passkeyChallengeID}: patch: x-mint: href: /api-reference/connect/backend/passkeychallenges/update-a-passkey-challenge-for-a-user summary: Update a passkey challenge for a user description: |- Updates a passkey challenge for a user by given `userID` and `passkeyChallengeID`. Required API key permission: `passkey_challenges:write`. operationId: PasskeyChallengeUpdate tags: - PasskeyChallenges security: - basicAuth: [] - bearerAuth: - passkey_challenges:write parameters: - $ref: "#/components/parameters/userID" - $ref: "#/components/parameters/passkeyChallengeID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyChallengeUpdateReq" responses: "200": description: Passkey challenge has been updated. content: application/json: schema: $ref: "#/components/schemas/passkeyChallenge" default: $ref: "#/components/responses/error" /users/{userID}/passwordManagers: get: summary: List password managers for a user description: Returns a list of password managers operationId: PasswordManagerList x-excluded: true tags: - PasswordManagers security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/userID" responses: "200": description: List of all matching password managers. content: application/json: schema: $ref: "#/components/schemas/passwordManagerList" default: $ref: "#/components/responses/error" /users/{userID}/clientEnvs: get: summary: List client environments for a user description: Returns a list of clientEnvs operationId: ClientEnvList x-excluded: true tags: - ClientEnvs security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/userID" responses: "200": description: List of all matching clientEnvs. content: application/json: schema: $ref: "#/components/schemas/clientEnvList" default: $ref: "#/components/responses/error" /identifiers: get: x-mint: href: /api-reference/connect/backend/identifiers/list-all-login-identifiers summary: List all login identifiers description: |- Lists login identifiers. Both `sort` and `filter` support `userID`, `identifierType` and `identifierValue`. See the parameters for sort directions and filter operators. Required API key permission: `identifiers:read`. operationId: IdentifierList tags: - Identifiers security: - basicAuth: [] - bearerAuth: - identifiers:read parameters: - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 responses: "200": description: List of all matching login identifiers. content: application/json: schema: $ref: "#/components/schemas/identifierList" default: $ref: "#/components/responses/error" /socialAccounts: get: x-excluded: true summary: List all social logins description: | Returns a list of social logins. The list can be sorted and filtered: - The `sort` parameter supports the following fields: `providerType` and `foreignID`. - The `filter` parameter supports the following fields: `providerType` and `foreignID`. Refer to the parameter description for more details on sorting in different directions and using the filter with different operators. operationId: SocialAccountList tags: - Users security: - basicAuth: [] - bearerAuth: [] parameters: - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 responses: "200": description: List of social logins. content: application/json: schema: $ref: "#/components/schemas/socialAccountList" default: $ref: "#/components/responses/error" /projectConfig/cname: put: summary: Update project CNAME and generate SSL certificate description: Update project config CNAME and generates new SSL certificate operationId: ProjectConfigUpdateCNAME x-excluded: true tags: - ProjectConfig security: - basicAuth: [] - bearerAuth: [] requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/projectConfigUpdateCnameReq" responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" /connectTokens: post: x-mint: href: /api-reference/connect/backend/connecttokens/create-a-connecttoken summary: Create a connectToken description: |- Creates a new ConnectToken, which is essential for [Corbado Connect](/corbado-connect/overview/welcome). ConnectTokens authorize actions that modify user data. Consult the [Documentation](/corbado-connect/concepts/connect-token) for more details. Required API key permission: `connect_tokens:write`. operationId: ConnectTokenCreate tags: - ConnectTokens security: - basicAuth: [] - bearerAuth: - connect_tokens:write requestBody: required: true content: application/json: example: type: passkey-append data: displayName: Example User identifier: user@example.com maxLifetimeInSeconds: 3600 schema: $ref: "#/components/schemas/connectTokenCreateReq" responses: "200": description: ConnectToken has been created. content: application/json: schema: $ref: "#/components/schemas/connectToken" default: $ref: "#/components/responses/error" get: x-mint: href: /api-reference/connect/backend/connecttokens/list-all-connecttokens summary: List all ConnectTokens description: |- Lists Connect tokens. Both `sort` and `filter` support `token`, `tokenType`, `status` and `expires`. See the parameters for sort directions and filter operators. Required API key permission: `connect_tokens:read`. operationId: ConnectTokenList tags: - ConnectTokens security: - basicAuth: [] - bearerAuth: - connect_tokens:read parameters: - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 responses: "200": description: List of all matching append tokens. content: application/json: schema: $ref: "#/components/schemas/connectTokenList" default: $ref: "#/components/responses/error" /connectTokens/{connectTokenID}: patch: x-mint: href: /api-reference/connect/backend/connecttokens/update-a-connecttoken summary: Update a ConnectToken description: |- Updates an existing ConnectToken. Required API key permission: `connect_tokens:write`. operationId: ConnectTokenUpdate tags: - ConnectTokens security: - basicAuth: [] - bearerAuth: - connect_tokens:write parameters: - $ref: "#/components/parameters/connectTokenID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/connectTokenUpdateReq" responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" delete: x-mint: href: /api-reference/connect/backend/connecttokens/delete-a-connecttoken summary: Delete a ConnectToken description: |- Deletes an existing ConnectToken. Required API key permission: `connect_tokens:write`. operationId: ConnectTokenDelete tags: - ConnectTokens security: - basicAuth: [] - bearerAuth: - connect_tokens:write parameters: - $ref: "#/components/parameters/connectTokenID" responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" /webhookEndpoints: get: summary: "List webhook endpoints" description: Returns a list of webhook endpoints operationId: WebhookEndpointList x-excluded: true tags: - WebhookEndpoints security: - basicAuth: [] - bearerAuth: [] responses: "200": description: List of webhook endpoints. content: application/json: schema: $ref: "#/components/schemas/webhookEndpointList" default: $ref: "#/components/responses/error" post: summary: "Create a webhook endpoint" description: Creates a new webhook endpoint operationId: WebhookEndpointCreate x-excluded: true tags: - WebhookEndpoints security: - basicAuth: [] - bearerAuth: [] requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/webhookEndpointCreateReq" responses: "200": description: Webhook endpoint has been created. content: application/json: schema: $ref: "#/components/schemas/webhookEndpoint" default: $ref: "#/components/responses/error" /webhookEndpoints/{webhookEndpointID}: put: summary: "Update a webhook endpoint" description: Updates an existing webhook endpoint operationId: WebhookEndpointUpdate x-excluded: true tags: - WebhookEndpoints security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/webhookEndpointID" requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/webhookEndpointUpdateReq" responses: "200": description: Webhook endpoint has been updated. content: application/json: schema: $ref: "#/components/schemas/webhookEndpoint" default: $ref: "#/components/responses/error" delete: summary: "Delete a webhook endpoint" description: Deletes an existing webhook endpoint operationId: WebhookEndpointDelete x-excluded: true tags: - WebhookEndpoints security: - basicAuth: [] - bearerAuth: [] parameters: - $ref: "#/components/parameters/webhookEndpointID" responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" /sessions: get: x-excluded: true summary: List all sessions description: | Returns a list of sessions. The list can be sorted and filtered: - The `sort` parameter supports the following fields: `ID`, `userID`, `expires`, `lastAction`, `created`, `updated`, and `status`. - The `filter` parameter supports the following fields: `ID`, `userID`, `expires`, `lastAction`, `created`, `updated`, and `status`. Refer to the parameter description for more details on sorting in different directions and using the filter with different operators. You can view and manage sessions in the [Management Console](https://app.corbado.com/users/sessions) or consult the [Documentation](https://docs.corbado.com/corbado-complete/sessions/overview) for more details. operationId: SessionList tags: - Sessions security: - basicAuth: [] - bearerAuth: [] parameters: - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 responses: "200": description: List of all matching sessions. content: application/json: schema: $ref: "#/components/schemas/sessionList" default: $ref: "#/components/responses/error" /sessions/{sessionID}/revoke: post: x-excluded: true summary: Revoke a session description: Revokes an existing session by given `sessionID`. operationId: SessionRevoke tags: - Sessions security: - basicAuth: [] - bearerAuth: [] parameters: - name: sessionID in: path description: ID of session required: true schema: type: string minLength: 30 maxLength: 30 responses: "200": $ref: "#/components/responses/200" default: $ref: "#/components/responses/error" /passkey/append/start: post: x-mint: href: /api-reference/connect/backend/passkeys/start-creating-a-new-passkey summary: Start creating a new passkey description: |- Starts creating a new passkey by initiating the WebAuthn ceremony. To complete the ceremony you need to call [finish](/api-reference/connect/backend/passkeys/finish-creating-a-new-passkey). Required API key permission: `passkeys:append`. operationId: PasskeyAppendStart tags: - Passkeys security: - basicAuth: [] - bearerAuth: - passkeys:append requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyAppendStartReq" responses: "200": description: Passkey creation process has been started. content: application/json: schema: $ref: "#/components/schemas/passkeyAppendStartRsp" default: $ref: "#/components/responses/error" /passkey/append/finish: post: x-mint: href: /api-reference/connect/backend/passkeys/finish-creating-a-new-passkey summary: Finish creating a new passkey description: |- Finishes creating a new passkey by completing the WebAuthn ceremony. Required API key permission: `passkeys:append`. operationId: PasskeyAppendFinish tags: - Passkeys security: - basicAuth: [] - bearerAuth: - passkeys:append requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyAppendFinishReq" responses: "200": description: Passkey append succeeded. content: application/json: schema: $ref: "#/components/schemas/passkeyAppendFinishRsp" default: $ref: "#/components/responses/error" /passkey/login/start: post: x-mint: href: /api-reference/connect/backend/passkeys/start-login-with-an-existing-passkey summary: Start login with an existing passkey description: |- Starts login with an existing passkey by initiating the WebAuthn ceremony. To complete the ceremony you need to call [finish](/api-reference/connect/backend/passkeys/finish-login-with-an-existing-passkey). Required API key permission: `passkeys:login`. operationId: PasskeyLoginStart tags: - Passkeys security: - basicAuth: [] - bearerAuth: - passkeys:login requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyLoginStartReq" responses: "200": description: Passkey authentication process has been started. content: application/json: schema: $ref: "#/components/schemas/passkeyLoginStartRsp" default: $ref: "#/components/responses/error" /passkey/login/finish: post: x-mint: href: /api-reference/connect/backend/passkeys/finish-login-with-an-existing-passkey summary: Finish login with an existing passkey description: |- Finishes login with an existing passkey by completing the WebAuthn ceremony. Required API key permission: `passkeys:login`. operationId: PasskeyLoginFinish tags: - Passkeys security: - basicAuth: [] - bearerAuth: - passkeys:login requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyLoginFinishReq" responses: "200": description: Passkey login succeeded. content: application/json: schema: $ref: "#/components/schemas/passkeyLoginFinishRsp" default: $ref: "#/components/responses/error" /sso/saml2/start: post: x-excluded: true summary: Start SAML2 SSO login description: Starts SAML2-based SSO login by resolving the project's SSO configuration for the email and returning an IdP redirect URL. operationId: SsoSaml2Start tags: - SSO security: - basicAuth: [] - bearerAuth: [] requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ssoSaml2StartReq" responses: "200": description: SSO start succeeded. content: application/json: schema: $ref: "#/components/schemas/ssoSaml2StartRsp" default: $ref: "#/components/responses/error" /sso/saml2/finish: post: x-excluded: true summary: Finish SAML2 SSO login description: | Finishes SAML2-based SSO login by validating the SAML response against the pending SSO session and resolving/provisioning a user. operationId: SsoSaml2Finish tags: - SSO security: - basicAuth: [] - bearerAuth: [] requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/ssoSaml2FinishReq" responses: "200": description: SSO finish succeeded. content: application/json: schema: $ref: "#/components/schemas/ssoSaml2FinishRsp" default: $ref: "#/components/responses/error" /passkey/postLogin: post: summary: Run the post-login action for passkey description: Explicitly runs the post-login action operationId: PasskeyPostLogin x-excluded: true tags: - Passkeys security: - basicAuth: [] - bearerAuth: [] requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyPostLoginReq" responses: "200": description: Post Passkey Login succeeded. content: application/json: schema: $ref: "#/components/schemas/passkeyPostLoginRsp" default: $ref: "#/components/responses/error" /passkey/verifySignedData: post: x-mint: href: /api-reference/connect/backend/passkeys/verify-signedpasskeydata-from-a-passkey-login summary: Verify signedPasskeyData from a passkey login description: |- Verifies `signedPasskeyData` returned by [Connect login finish](/api-reference/connect/frontend/corbadoconnect/finish-connect-login). Set `username` to the expected WebAuthn identifier. Create an application session only when the HTTP request succeeds and `verificationResult` is `success`; decoding a JWT alone does not verify it. See [signed passkey data](/corbado-connect/concepts/signed-passkey-data) and the [backend integration guide](/corbado-connect/integration/generic/backend). Required API key permission: `passkeys:verify`. operationId: PasskeyVerifySignedData tags: - Passkeys security: - basicAuth: [] - bearerAuth: - passkeys:verify requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyVerifySignedDataReq" responses: "200": description: | `signedPasskeyData` has been verified. content: application/json: schema: $ref: "#/components/schemas/passkeyVerifySignedDataRsp" default: $ref: "#/components/responses/error" /passkey/mediation/start: post: x-mint: href: /api-reference/connect/backend/passkeys/start-login-with-an-existing-passkey-conditional-ui summary: Start login with an existing passkey (Conditional UI) description: |- Starts login with an existing passkey in [Conditional UI](https://www.corbado.com/glossary/conditional-ui) scenario. To complete the ceremony you need to call [finish](/api-reference/connect/backend/passkeys/finish-login-with-an-existing-passkey-conditional-ui). Required API key permission: `passkeys:mediation`. operationId: PasskeyMediationStart tags: - Passkeys security: - basicAuth: [] - bearerAuth: - passkeys:mediation requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyMediationStartReq" responses: "200": description: Passkey login process has been started. content: application/json: schema: $ref: "#/components/schemas/passkeyMediationStartRsp" default: $ref: "#/components/responses/error" /passkey/mediation/finish: post: x-mint: href: /api-reference/connect/backend/passkeys/finish-login-with-an-existing-passkey-conditional-ui summary: Finish login with an existing passkey (Conditional UI) description: |- Finishes login with an existing passkey in [Conditional UI](https://www.corbado.com/glossary/conditional-ui) scenario. Required API key permission: `passkeys:mediation`. operationId: PasskeyMediationFinish tags: - Passkeys security: - basicAuth: [] - bearerAuth: - passkeys:mediation requestBody: required: true content: application/json: schema: $ref: "#/components/schemas/passkeyMediationFinishReq" responses: "200": description: Passkey login process has been completed. content: application/json: schema: $ref: "#/components/schemas/passkeyMediationFinishRsp" default: $ref: "#/components/responses/error" /exports/{exportType}: get: x-mint: href: /api-reference/connect/backend/exports/list-project-exports summary: List project exports description: |- Returns a list of available export files for the authenticated project and export type. Required API key permission: `exports:read`. operationId: ExportList tags: - Exports security: - basicAuth: [] - bearerAuth: - exports:read parameters: - name: exportType in: path required: true description: Type of export to list schema: $ref: "#/components/schemas/exportType" responses: "200": description: List of export files content: application/json: schema: $ref: "#/components/schemas/exportList" default: $ref: "#/components/responses/error" /exports/{exportType}/{filename}/downloadLink: get: x-mint: href: /api-reference/connect/backend/exports/get-download-link-for-an-export-file summary: Get download link for an export file description: |- Generates a pre-signed download link for a specific export file. Required API key permission: `exports:read`. operationId: ExportDownloadLinkGet tags: - Exports security: - basicAuth: [] - bearerAuth: - exports:read parameters: - name: exportType in: path required: true description: Type of export to download schema: $ref: "#/components/schemas/exportType" - name: filename in: path required: true description: Name of the export file schema: type: string responses: "200": description: Pre-signed download link content: application/json: schema: $ref: "#/components/schemas/exportDownloadLink" default: $ref: "#/components/responses/error" /stats: get: summary: "Get project statistics" x-mint: href: /api-reference/connect/backend/connect-reads/get-stats metadata: sidebarTitle: "Get project statistics" description: |- Retrieves stats for a project Required API key permission: `analytics:read`. operationId: publicGetStats tags: - Connect reads parameters: - name: interval in: query description: interval as string required: true schema: type: string enum: - minutely - hourly - daily - monthly - name: queryType in: query description: queryType as string required: true schema: type: string - name: applicationID in: query required: false schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: tbd content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendStatsGetRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - analytics:read /statsByTime: get: summary: "Get statistics over time" x-mint: href: /api-reference/connect/backend/connect-reads/get-statsbytime metadata: sidebarTitle: "Get statistics over time" description: |- Retrieves stats for a project (grouped by time) Required API key permission: `analytics:read`. operationId: publicGetStatsByTime tags: - Connect reads parameters: - name: fromDate in: query description: date range start required: true schema: type: string - name: toDate in: query description: date range end required: true schema: type: string - name: interval in: query description: interval as string required: true schema: type: string enum: - minutely - hourly - daily - monthly - name: queryType in: query description: queryType as string required: true schema: type: string - name: applicationID in: query required: false schema: type: string - name: osName in: query required: false schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: tbd content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendStatsByTimeGetRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - analytics:read /connect/applications: post: summary: "Create an application" x-mint: href: /api-reference/connect/backend/connectmanagement/post-connectapplications metadata: sidebarTitle: "Create an application" operationId: publicApplicationCreate description: |- Creates a Connect application. The project is selected by X-Corbado-ProjectID. At most one web application is allowed per project. Required API key permission: `applications:write`. tags: - ConnectManagement requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectApplicationSaveReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Saved application content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectApplicationSaveRsp' security: - basicAuth: [] - bearerAuth: - applications:write get: summary: "List applications" x-mint: href: /api-reference/connect/backend/connect-reads/get-connectapplications metadata: sidebarTitle: "List applications" description: |- Retrieves a list of applications for a project Required API key permission: `applications:read`. operationId: publicApplicationList tags: - Connect reads responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List of project applications content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectApplicationListRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - applications:read /connect/processSearch: post: summary: "Search Connect processes" x-mint: href: /api-reference/connect/backend/connect-reads/post-connectprocesssearch metadata: sidebarTitle: "Search Connect processes" description: |- Retrieves a list of processes Required API key permission: `processes:read`. operationId: publicConnectProcessSearch tags: - Connect reads requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectProcessSearchReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectProcessSearchRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - processes:read /connect/processList: post: summary: "Get Connect processes by ID" x-mint: href: /api-reference/connect/backend/connect-reads/post-connectprocesslist metadata: sidebarTitle: "Get Connect processes by ID" description: |- Retrieves a list of processes for by their IDs Required API key permission: `processes:read`. operationId: publicConnectProcessList tags: - Connect reads requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectProcessListReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectProcessListRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - processes:read /connect/processes/{processID}/events: get: summary: "List process events" x-mint: href: /api-reference/connect/backend/connect-reads/get-connectprocesses-events metadata: sidebarTitle: "List process events" description: |- Retrieves all events for a process Required API key permission: `processes:read`. operationId: publicConnectProcessEventsGet tags: - Connect reads parameters: - name: processID in: path description: The process ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectProcessEventsGetRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - processes:read /connect/processMetadata/{processID}: get: summary: "Get process metadata" x-mint: href: /api-reference/connect/backend/connect-reads/get-connectprocessmetadata metadata: sidebarTitle: "Get process metadata" description: |- Retrieves metadata for a process Required API key permission: `processes:read`. operationId: publicConnectProcessMetadataGet tags: - Connect reads parameters: - name: processID in: path description: The process ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectProcessMetadataGetRsp' '404': description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - processes:read /connect/processes/{processID}/subProcesses: get: summary: "List subprocesses" x-mint: href: /api-reference/connect/backend/connect-reads/get-connectprocesses-subprocesses metadata: sidebarTitle: "List subprocesses" description: |- Retrieves all subprocesses for a process Required API key permission: `processes:read`. operationId: publicConnectSubProcessList tags: - Connect reads parameters: - name: processID in: path description: The process ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectSubProcessListRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - processes:read /connect/processErrors: get: summary: "List process errors" x-mint: href: /api-reference/connect/backend/connect-reads/get-connectprocesserrors metadata: sidebarTitle: "List process errors" description: |- Retrieves a list of errors for a project Required API key permission: `processes:read`. operationId: publicConnectErrorList tags: - Connect reads parameters: - name: errorPatternID in: query description: The error pattern ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List of project errors content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectProcessErrorListRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - processes:read /connect/processErrorPatterns: get: summary: "List error patterns" x-mint: href: /api-reference/connect/backend/connect-reads/get-connectprocesserrorpatterns metadata: sidebarTitle: "List error patterns" description: |- Retrieves error patterns Required API key permission: `processes:read`. operationId: publicConnectErrorPatternList tags: - Connect reads responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List of error patterns content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectProcessErrorPatternListRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - processes:read /devices: post: x-mint: href: /api-reference/connect/backend/connect-reads/list-devices-for-multiple-users summary: List devices for multiple users description: |- Returns a list of devices for multiple users at once Required API key permission: `devices:read`. operationId: publicDeviceBatchList tags: - Connect reads security: - basicAuth: [] - bearerAuth: - devices:read requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendDeviceBatchListReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List of all devices for the provided users. content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendDeviceBatchList' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied /sharedDevices: get: summary: "List shared devices for a user" x-mint: href: /api-reference/connect/backend/connect-reads/get-shareddevices metadata: sidebarTitle: "List shared devices for a user" description: |- Lists shared devices for a given userID Required API key permission: `devices:read`. operationId: publicSharedDeviceList tags: - Connect reads security: - basicAuth: [] - bearerAuth: - devices:read parameters: - name: userID in: query description: userID to filter shared devices for required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List of shared devices for the provided user. content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendSharedDeviceList' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied /androidappconfig: post: summary: "Create an Android app configuration" x-mint: href: /api-reference/connect/backend/connectmanagement/post-androidappconfig metadata: sidebarTitle: "Create an Android app configuration" description: |- Creates a new Android App Configuration Required API key permission: `applications:write`. operationId: publicAndroidAppConfigCreate tags: - ConnectManagement security: - basicAuth: [] - bearerAuth: - applications:write requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigSaveReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Android App Config successfully created content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigSaveRsp' get: summary: "List Android app configurations" x-mint: href: /api-reference/connect/backend/connect-reads/get-androidappconfig metadata: sidebarTitle: "List Android app configurations" description: |- Lists Android App Configurations for a project Required API key permission: `applications:read`. operationId: publicAndroidAppConfigGet tags: - Connect reads security: - basicAuth: [] - bearerAuth: - applications:read responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Android App Config List successfully retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigListRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied /passkeyIntelligence/{projectID}/rulesetsMetadata: get: summary: "List Passkey Intelligence rulesets" x-mint: href: /api-reference/connect/backend/connect-reads/get-passkeyintelligence-rulesetsmetadata metadata: sidebarTitle: "List Passkey Intelligence rulesets" description: |- Retrieves a list of ruleSets Metadata for a Connect project Required API key permission: `rulesets:read`. operationId: publicPasskeyIntelligenceRulesetsList tags: - Connect reads parameters: - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 - name: projectID in: path description: The project ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List of project rulesets content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendPasskeyIntelligenceRulesetMetadataListRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - rulesets:read /passkeyIntelligence/{projectID}/rulesets/{rulesetID}: get: summary: "Get a Passkey Intelligence ruleset" x-mint: href: /api-reference/connect/backend/connect-reads/get-passkeyintelligence-rulesets metadata: sidebarTitle: "Get a Passkey Intelligence ruleset" description: |- Retrieves a specific ruleset using rulesetID Required API key permission: `rulesets:read`. operationId: publicPasskeyIntelligenceRulesetGet tags: - Connect reads parameters: - name: rulesetID in: path description: The ruleset ID required: true schema: type: string - name: projectID in: path description: The project ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendPasskeyIntelligenceRulesetGetRsp' '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied security: - basicAuth: [] - bearerAuth: - rulesets:read /projectConfig: get: summary: "Get project configuration" x-mint: href: /api-reference/connect/backend/connect-reads/get-projectconfig metadata: sidebarTitle: "Get project configuration" description: |- Retrieves project config by projectID Required API key permission: `project_config:read`. operationId: publicProjectConfigGet tags: - Connect reads security: - basicAuth: [] - bearerAuth: - project_config:read responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Public project configuration; excludes SMTP credentials. content: application/json: schema: type: object required: - data properties: data: type: object required: - projectID - externalName - applicationUrl - webauthnRPID - environment - cname - frontendAPIUrl - backendAPIUrl - autoDetectLanguage - fallbackLanguage - supportEmail - userVerification - status properties: projectID: type: string externalName: type: string applicationUrl: type: string webauthnRPID: type: string environment: type: string enum: - dev - prod cname: type: string frontendAPIUrl: type: string backendAPIUrl: type: string autoDetectLanguage: type: boolean fallbackLanguage: type: string supportEmail: type: string userVerification: type: string status: type: string '401': description: Authentication or API-key permission denied '403': description: Authentication or API-key permission denied /connect/applications/{applicationID}: put: summary: "Update an application" x-mint: href: /api-reference/connect/backend/connectmanagement/put-connectapplications metadata: sidebarTitle: "Update an application" operationId: publicApplicationUpdate description: |- Updates an application in the header-selected project, preserving its ID. Does not reprocess history or remove Android registrations. Required API key permission: `applications:write`. tags: - ConnectManagement requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectApplicationSaveReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Saved application content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendConnectApplicationSaveRsp' security: - basicAuth: [] - bearerAuth: - applications:write parameters: - name: applicationID in: path required: true schema: type: string pattern: ^[1-9][0-9]*$ delete: summary: "Delete an application" x-mint: href: /api-reference/connect/backend/connectmanagement/delete-connectapplications metadata: sidebarTitle: "Delete an application" operationId: publicApplicationDelete description: |- Hard-deletes an application in the header-selected project. Retains analytics rows and Android registrations. Required API key permission: `applications:write`. tags: - ConnectManagement responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Application deleted security: - basicAuth: [] - bearerAuth: - applications:write parameters: - name: applicationID in: path required: true schema: type: string pattern: ^[1-9][0-9]*$ /androidappconfig/{androidAppConfigID}: put: summary: "Update an Android app configuration" x-mint: href: /api-reference/connect/backend/connectmanagement/put-androidappconfig metadata: sidebarTitle: "Update an Android app configuration" description: |- Updates an Android app config by id Required API key permission: `applications:write`. operationId: publicAndroidAppConfigPut tags: - ConnectManagement parameters: - in: path required: true name: androidAppConfigID schema: type: string description: ID from Android config create example: and-abc123 security: - basicAuth: [] - bearerAuth: - applications:write requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigUpdateReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Contains Android app config content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigUpdateRsp' delete: summary: "Delete an Android app configuration" x-mint: href: /api-reference/connect/backend/connectmanagement/delete-androidappconfig metadata: sidebarTitle: "Delete an Android app configuration" description: |- Deletes an Android App Config Required API key permission: `applications:write`. operationId: publicAndroidAppConfigDelete tags: - ConnectManagement security: - basicAuth: [] - bearerAuth: - applications:write parameters: - in: path required: true name: androidAppConfigID schema: type: string description: Android App Config ID from create example: and-abc123 requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigDeleteReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Operation succeeded content: application/json: schema: type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 /passkeyIntelligence/{projectID}/rulesets: post: summary: "Create a Passkey Intelligence ruleset" x-mint: href: /api-reference/connect/backend/connectmanagement/post-passkeyintelligence-rulesets metadata: sidebarTitle: "Create a Passkey Intelligence ruleset" description: |- Adds new ruleset to project Required API key permission: `rulesets:write`. operationId: publicPasskeyIntelligenceRulesetCreate tags: - ConnectManagement parameters: - name: projectID in: path description: The project ID required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendPasskeyIntelligenceRulesetCreateReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Returns newly created ruleset id content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendPasskeyIntelligenceRulesetCreateRsp' security: - basicAuth: [] - bearerAuth: - rulesets:write /passkeyIntelligence/{projectID}/rulesets/{rulesetID}/activate: post: summary: "Activate a Passkey Intelligence ruleset" x-mint: href: /api-reference/connect/backend/connectmanagement/post-passkeyintelligence-rulesets-activate metadata: sidebarTitle: "Activate a Passkey Intelligence ruleset" description: |- Activates a specific ruleset using rulesetID Required API key permission: `rulesets:write`. operationId: publicPasskeyIntelligenceRulesetActivate tags: - ConnectManagement parameters: - name: rulesetID in: path description: The ruleset ID required: true schema: type: string - name: projectID in: path description: The project ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectReadBackendPasskeyIntelligenceRulesetActivateReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Operation succeeded content: application/json: schema: type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 security: - basicAuth: [] - bearerAuth: - rulesets:write /connect/config: get: summary: "Get Connect configuration" x-mint: href: /api-reference/connect/backend/connectrollout/get-connectconfig metadata: sidebarTitle: "Get Connect configuration" description: |- Retrieves the connect config for a project Required API key permission: `connect_config:read`. operationId: GetConnectConfig tags: - ConnectRollout responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: tbd content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectConfigGetRsp' security: - basicAuth: [] - bearerAuth: - connect_config:read put: summary: "Update Connect configuration" x-mint: href: /api-reference/connect/backend/connectrollout/put-connectconfig metadata: sidebarTitle: "Update Connect configuration" description: |- Updates the connect config for a project Required API key permission: `connect_config:write`. operationId: UpdateConnectConfig tags: - ConnectRollout requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectConfigPutReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List successfully updated content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectConfigPutRsp' security: - basicAuth: [] - bearerAuth: - connect_config:write post: summary: "Create Connect configuration" x-mint: href: /api-reference/connect/backend/connectrollout/post-connectconfig metadata: sidebarTitle: "Create Connect configuration" description: |- Creates a new connect config for the project Required API key permission: `connect_config:write`. operationId: CreateConnectConfig tags: - ConnectRollout requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectConfigPostReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully created content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectConfigPostRsp' security: - basicAuth: [] - bearerAuth: - connect_config:write /connect/rulesetsMetadata: get: summary: "List rollout rulesets" x-mint: href: /api-reference/connect/backend/connectrollout/get-connectrulesetsmetadata metadata: sidebarTitle: "List rollout rulesets" description: |- Retrieves a list of ruleSets Metadata for a Connect project Required API key permission: `connect_rulesets:read`. operationId: ConnectRulesetsList tags: - ConnectRollout parameters: - name: filter[] in: query description: "Filter results by specific fields and conditions. Format: `::`.\nSupported operators include: \n - `eq`: equals (e\\.g\\. `email:eq:mail@example\\.com` matches items where email equals mail@example\\.com) \n - `gt`: greater than (e\\.g\\. `created:gt:2021-01-01T00:00:00` matches items created after Jan 1, 2021) \n - `lt`: less than (e\\.g\\. `created:lt:2021-01-01T00:00:00` matches items created before Jan 1, 2021)\n" required: false style: form explode: true schema: type: array items: type: string examples: filterEmail: summary: Filter by email address value: - identifierType:eq:email - identifierValue:eq:mail@example.com filterTimepoint: summary: Filter by date after July 20, 2021 value: - timePoint:gt:2021-07-20T00:00:00 - name: sort in: query description: | Field and direction to sort results. Use the format `fieldName:asc` or `fieldName:desc`. required: false schema: type: string example: createdAt:desc - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List of project rulesets content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectRulesetMetadataListRsp' security: - basicAuth: [] - bearerAuth: - connect_rulesets:read /connect/rulesets: post: summary: "Create a rollout ruleset" x-mint: href: /api-reference/connect/backend/connectrollout/post-connectrulesets metadata: sidebarTitle: "Create a rollout ruleset" description: |- Adds new ruleset to project Required API key permission: `connect_rulesets:write`. operationId: ConnectRulesetCreate tags: - ConnectRollout requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectRulesetCreateReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully Created content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectRulesetCreateRsp' '400': description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string security: - basicAuth: [] - bearerAuth: - connect_rulesets:write /connect/rulesets/{rulesetID}: get: summary: "Get a rollout ruleset" x-mint: href: /api-reference/connect/backend/connectrollout/get-connectrulesets metadata: sidebarTitle: "Get a rollout ruleset" description: |- Retrieves a specific ruleset using rulesetID Required API key permission: `connect_rulesets:read`. operationId: ConnectRulesetGet tags: - ConnectRollout parameters: - name: rulesetID in: path description: The ruleset ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully retrieved content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectRulesetGetRsp' security: - basicAuth: [] - bearerAuth: - connect_rulesets:read patch: summary: "Update a rollout ruleset" x-mint: href: /api-reference/connect/backend/connectrollout/patch-connectrulesets metadata: sidebarTitle: "Update a rollout ruleset" description: |- Updates a specific ruleset using rulesetID Required API key permission: `connect_rulesets:write`. operationId: ConnectRulesetUpdate tags: - ConnectRollout parameters: - name: rulesetID in: path description: The ruleset ID required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectRulesetUpdateReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Operation succeeded content: application/json: schema: type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 security: - basicAuth: [] - bearerAuth: - connect_rulesets:write /connect/rulesets/{rulesetID}/activate: post: summary: "Activate a rollout ruleset" x-mint: href: /api-reference/connect/backend/connectrollout/post-connectrulesets-activate metadata: sidebarTitle: "Activate a rollout ruleset" description: |- Activates a specific ruleset using rulesetID Required API key permission: `connect_rulesets:write`. operationId: ConnectRulesetActivate tags: - ConnectRollout parameters: - name: rulesetID in: path description: The ruleset ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Operation succeeded content: application/json: schema: type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 security: - basicAuth: [] - bearerAuth: - connect_rulesets:write /connect/identifierWhitelists: post: summary: "Create an identifier allowlist" x-mint: href: /api-reference/connect/backend/connectrollout/post-connectidentifierwhitelists metadata: sidebarTitle: "Create an identifier allowlist" description: |- Creates a new identifier whitelist to a project Required API key permission: `identifier_whitelists:write`. operationId: IdentifierWhitelistCreate tags: - ConnectRollout requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectManagementIdentifierWhitelistCreateReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Identifier whitelist successfully created content: application/json: schema: $ref: '#/components/schemas/ConnectManagementIdentifierWhitelistCreateRsp' security: - basicAuth: [] - bearerAuth: - identifier_whitelists:write get: summary: "List identifier allowlists" x-mint: href: /api-reference/connect/backend/connectrollout/get-connectidentifierwhitelists metadata: sidebarTitle: "List identifier allowlists" description: |- Retrieves a list of identifier whitelists for a project Required API key permission: `identifier_whitelists:read`. operationId: IdentifierWhitelistList tags: - ConnectRollout responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List of project identifier whitelists content: application/json: schema: $ref: '#/components/schemas/ConnectManagementIdentifierWhitelistListRsp' security: - basicAuth: [] - bearerAuth: - identifier_whitelists:read /connect/identifierWhitelists/{identifierWhitelistID}: put: summary: "Update an identifier allowlist" x-mint: href: /api-reference/connect/backend/connectrollout/put-connectidentifierwhitelists metadata: sidebarTitle: "Update an identifier allowlist" description: |- Updates an existing identifier whitelist Required API key permission: `identifier_whitelists:write`. operationId: IdentifierWhitelistUpdate tags: - ConnectRollout parameters: - name: identifierWhitelistID in: path description: The identifier whitelist ID required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConnectManagementIdentifierWhitelistUpdateReq' responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List successfully updated content: application/json: schema: $ref: '#/components/schemas/ConnectManagementIdentifierWhitelistUpdateRsp' security: - basicAuth: [] - bearerAuth: - identifier_whitelists:write delete: summary: "Delete an identifier allowlist" x-mint: href: /api-reference/connect/backend/connectrollout/delete-connectidentifierwhitelists metadata: sidebarTitle: "Delete an identifier allowlist" description: |- Deletes an existing identifier whitelist Required API key permission: `identifier_whitelists:write`. operationId: IdentifierWhitelistDelete tags: - ConnectRollout parameters: - name: identifierWhitelistID in: path description: The identifier whitelist ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: List successfully deleted content: application/json: schema: type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 security: - basicAuth: [] - bearerAuth: - identifier_whitelists:write /connect/rulesets/{rulesetID}/simulations: post: summary: "Create a rollout simulation" x-mint: href: /api-reference/connect/backend/connectrollout/post-connectrulesets-simulations metadata: sidebarTitle: "Create a rollout simulation" description: |- Create a simulation of a specific ruleset using rulesetID Required API key permission: `ruleset_simulations:write`. operationId: ConnectRulesetSimulationCreate tags: - ConnectRollout parameters: - name: rulesetID in: path description: The ruleset ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully created content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectRulesetSimulationCreateRsp' security: - basicAuth: [] - bearerAuth: - ruleset_simulations:write get: summary: "List rollout simulations" x-mint: href: /api-reference/connect/backend/connectrollout/get-connectrulesets-simulations metadata: sidebarTitle: "List rollout simulations" description: |- Get the list of project and ruleset simulations Required API key permission: `ruleset_simulations:read`. operationId: ConnectRulesetSimulationListGet tags: - ConnectRollout parameters: - name: rulesetID in: path description: The ruleset ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully created content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectRulesetSimulationListRsp' security: - basicAuth: [] - bearerAuth: - ruleset_simulations:read /connect/rulesets/{rulesetID}/simulations/{simulationID}: get: summary: "Get rollout simulation status" x-mint: href: /api-reference/connect/backend/connectrollout/get-connectrulesets-simulations-1 metadata: sidebarTitle: "Get rollout simulation status" description: |- Get the status of a simulation of a specific ruleset using rulesetID and simulationID Required API key permission: `ruleset_simulations:read`. operationId: ConnectRulesetSimulationGet tags: - ConnectRollout parameters: - name: rulesetID in: path description: The ruleset ID required: true schema: type: string - name: simulationID in: path description: The simulation ID required: true schema: type: string responses: default: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string '200': description: Successfully created content: application/json: schema: $ref: '#/components/schemas/ConnectManagementConnectRulesetSimulationGetRsp' security: - basicAuth: [] - bearerAuth: - ruleset_simulations:read components: securitySchemes: bearerAuth: type: http scheme: bearer description: |- Use your versioned Backend API key. The key must grant the operation permission and satisfy its expiry and IP restrictions. basicAuth: type: http scheme: basic description: | Basic authentication is used to authenticate requests to the Backend API. The username is the project ID and the password is the API secret. The project ID and API secret can be found in the [Management Console](https://app.corbado.com/settings/api-secrets). parameters: userID: name: userID in: path description: | Unique identifier of the user. Format: `usr-`. required: true schema: type: string example: usr-4693224802260150919 challengeID: name: challengeID in: path description: ID of challenge required: true schema: type: string identifierID: name: identifierID in: path description: | Unique identifier of the login identifier (e.g., email address or phone number). Format: `ide-`. required: true schema: type: string example: "ide-4693224802260150919" credentialID: name: credentialID in: path description: | Unique identifier of the passkey. Format: `cre-`. required: true schema: type: string example: "cre-4693224802260150919" connectTokenID: name: connectTokenID in: path description: | Unique identifier of the connectToken. Format: `ctk-`. required: true schema: type: string example: "ctk-4693224802260150919" passkeyChallengeID: name: passkeyChallengeID in: path description: ID of a passkey challenge required: true schema: type: string passkeyEventID: name: passkeyEventID in: path description: ID of a passkey event required: true schema: type: string webhookEndpointID: name: webhookEndpointID in: path description: ID of a webhook endpoint required: true schema: type: string includeAllStatus: name: includeAllStatus in: query description: Whether to include all status types (including `deleted`) in the response. Default is `false`, which excludes `deleted` items. required: false schema: type: boolean default: false schemas: session: type: object required: - sessionID - userID - identifierValue - createdMs - lastActionMs - expiresMs - status properties: sessionID: type: string description: Unique identifier of the session. example: "V4Gy2mCXekKuvKwbG81ysvegY9dB01" userID: type: string description: Unique identifier of the user. example: "usr-4693224802260150919" identifierValue: type: string description: Login identifier of the user (here email address). example: "jane@doe.com" createdMs: type: integer format: int64 description: Unix time of when the session was created (in milliseconds elapsed since January 1, 1970, 00:00:00 UTC). example: 1752738240000 lastActionMs: type: integer format: int64 description: Unix time of when last action (e.g., refresh) on session occurred (in milliseconds elapsed since January 1, 1970, 00:00:00 UTC). example: 1752738240000 expiresMs: type: integer format: int64 description: Unix time of when the session expires (in milliseconds elapsed since January 1, 1970, 00:00:00 UTC). example: 1755330240000 status: type: string enum: ['active', 'logged_out', 'expired', 'inactivity_reached', 'revoked'] ConnectReadBackendConnectApplicationSaveReq: type: object required: - name - clientType - clientIdentifier properties: name: type: string minLength: 1 maxLength: 100 clientType: type: string enum: - web - app - api clientIdentifier: type: string maxLength: 100 description: Package or bundle identifier for native applications; unused for web matching. osName: type: string enum: - android - iOS description: Omit for native applications matching either OS. Must be omitted for web and API applications. androidFingerprintsToAdd: type: array maxItems: 20 description: Optional SHA-256 certificates to register atomically for this Android package. Existing registrations are retained. items: type: string pattern: ^([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}$ ConnectReadBackendConnectApplicationSaveRsp: type: object required: - item properties: item: $ref: '#/components/schemas/ConnectReadBackendConnectApplication' ConnectReadBackendAndroidAppConfigSaveReq: type: object required: - projectID - packageName - fingerprint properties: projectID: description: ID of project type: string x-oapi-codegen-extra-tags: validate: required,id=pro packageName: type: string fingerprint: type: string requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' clientInfo: type: object required: - remoteAddress - userAgent properties: remoteAddress: description: client's IP address type: string example: '::ffff:172.18.0.1' userAgent: description: client's User Agent type: string example: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36' ConnectReadBackendAndroidAppConfigSaveRsp: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigItem' ConnectReadBackendAndroidAppConfigUpdateReq: type: object required: - projectID - packageName - fingerprint properties: projectID: description: ID of project type: string x-oapi-codegen-extra-tags: validate: required,id=pro packageName: type: string fingerprint: type: string requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' clientInfo: type: object required: - remoteAddress - userAgent properties: remoteAddress: description: client's IP address type: string example: '::ffff:172.18.0.1' userAgent: description: client's User Agent type: string example: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36' ConnectReadBackendAndroidAppConfigUpdateRsp: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigItem' ConnectReadBackendAndroidAppConfigDeleteReq: type: object properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' clientInfo: type: object required: - remoteAddress - userAgent properties: remoteAddress: description: client's IP address type: string example: '::ffff:172.18.0.1' userAgent: description: client's User Agent type: string example: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36' ConnectReadBackendPasskeyIntelligenceRulesetCreateReq: type: object required: - ruleType - content properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' isActive: type: boolean ruleType: type: string content: type: string ConnectReadBackendPasskeyIntelligenceRulesetCreateRsp: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - rulesetID properties: rulesetID: type: string ConnectReadBackendPasskeyIntelligenceRulesetActivateReq: type: object properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' ConnectManagementConnectConfigGetRsp: type: object required: - item properties: item: $ref: '#/components/schemas/ConnectManagementConnectConfig' ConnectManagementConnectConfig: type: object required: - projectID - loginKillSwitchActive - appendKillSwitchActive - manageKillSwitchActive - requireConnectLoginToken - requireWhitelistedIdentifier properties: projectID: type: string loginKillSwitchActive: type: boolean appendKillSwitchActive: type: boolean manageKillSwitchActive: type: boolean requireConnectLoginToken: type: boolean requireWhitelistedIdentifier: type: boolean ConnectManagementConnectConfigPutReq: type: object required: - loginKillSwitchActive - appendKillSwitchActive - manageKillSwitchActive - requireConnectLoginToken - requireWhitelistedIdentifier properties: loginKillSwitchActive: type: boolean appendKillSwitchActive: type: boolean manageKillSwitchActive: type: boolean requireConnectLoginToken: type: boolean requireWhitelistedIdentifier: type: boolean ConnectManagementConnectConfigPutRsp: type: object required: - item properties: item: $ref: '#/components/schemas/ConnectManagementConnectConfig' ConnectManagementConnectConfigPostReq: type: object required: - requireConnectLoginToken - requireWhitelistedIdentifier - immediatePostLogin - activeSplits properties: requireConnectLoginToken: type: boolean requireWhitelistedIdentifier: type: boolean immediatePostLogin: type: boolean activeSplits: type: string cookieDomain: type: string ConnectManagementConnectConfigPostRsp: type: object required: - item properties: item: $ref: '#/components/schemas/ConnectManagementConnectConfig' ConnectManagementConnectRulesetMetadataListRsp: type: object required: - items - paging properties: items: type: array items: $ref: '#/components/schemas/ConnectManagementConnectRulesetMetadata' paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer ConnectManagementConnectRulesetMetadata: type: object required: - name - isActive - rulesetID - type - version - createdMs properties: name: type: string isActive: type: boolean rulesetID: type: string version: type: integer type: type: string createdMs: type: integer format: int64 ConnectManagementConnectRulesetCreateReq: type: object required: - ruleType - content - name properties: name: type: string isActive: type: boolean ruleType: type: string content: type: string ConnectManagementConnectRulesetCreateRsp: type: object required: - rulesetID properties: rulesetID: type: string ConnectManagementConnectRulesetGetRsp: type: object required: - data properties: data: $ref: '#/components/schemas/ConnectManagementConnectRuleset' ConnectManagementConnectRuleset: type: object required: - content - metaData properties: content: type: string metaData: $ref: '#/components/schemas/ConnectManagementConnectRulesetMetadata' ConnectManagementConnectRulesetUpdateReq: type: object required: - name properties: name: type: string ConnectManagementIdentifierWhitelistCreateReq: type: object required: - name - identifiers properties: name: type: string identifiers: type: string ConnectManagementIdentifierWhitelistCreateRsp: type: object required: - item properties: item: $ref: '#/components/schemas/ConnectManagementIdentifierWhitelist' ConnectManagementIdentifierWhitelist: type: object required: - id - name - identifiers - createdMs properties: id: type: string name: type: string identifiers: type: string createdMs: type: integer format: int64 ConnectManagementIdentifierWhitelistListRsp: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ConnectManagementIdentifierWhitelist' ConnectManagementIdentifierWhitelistUpdateReq: type: object required: - name - identifiers properties: name: type: string identifiers: type: string ConnectManagementIdentifierWhitelistUpdateRsp: type: object required: - item properties: item: $ref: '#/components/schemas/ConnectManagementIdentifierWhitelist' ConnectManagementConnectRulesetSimulationCreateRsp: type: object required: - simulationID properties: simulationID: type: string ConnectManagementConnectRulesetSimulationListRsp: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/ConnectManagementConnectRulesetSimulationGetRsp' ConnectManagementConnectRulesetSimulationGetRsp: type: object required: - createdMs - status - id properties: id: type: string status: type: string enum: - pending - completed - failed message: type: string errorCount: type: integer createdMs: type: integer format: int64 data: type: array items: $ref: '#/components/schemas/ConnectManagementConnectRulesetSimulationResult' ConnectManagementConnectRulesetSimulationResult: type: object required: - status - message - count properties: status: type: string message: type: string count: type: integer format: int64 userCreateReq: type: object required: - status properties: fullName: type: string example: "Jane Doe" status: $ref: "#/components/schemas/userStatus" explicitWebauthnID: type: string description: For [Corbado Connect](https://docs.corbado.com/corbado-connect) projects, the webauthnID can be explicitly set for a user userUpdateReq: type: object properties: fullName: type: string example: "Jane Doe" name: type: string status: $ref: "#/components/schemas/userStatus" challengeCreateReq: type: object required: - challengeType - identifierValue - clientInformation properties: challengeType: $ref: "#/components/schemas/challengeType" identifierValue: type: string example: "jane@doe.com" challengeMetadata: type: object example: city: Munich lifetimeSeconds: type: integer example: 300 clientInformation: $ref: "#/components/schemas/clientInformation" challengeUpdateReq: type: object required: - value properties: value: type: string identifierCreateReq: type: object required: - identifierType - identifierValue - status properties: identifierType: $ref: "#/components/schemas/identifierType" identifierValue: type: string status: $ref: "#/components/schemas/identifierStatus" identifierUpdateReq: type: object required: - status properties: status: $ref: "#/components/schemas/identifierStatus" passkeyAppendStartReq: type: object required: - userID - processID - username - clientInformation - passkeyIntelFlags - situation properties: userID: description: ID of the user type: string processID: type: string username: type: string clientInformation: $ref: "#/components/schemas/clientInformation" passkeyIntelFlags: $ref: "#/components/schemas/passkeyIntelFlags" situation: type: string passkeyAppendStartRsp: type: object required: - appendAllow - attestationOptions - detectionInsights - decisionInsights properties: appendAllow: type: boolean 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"}}' detectionInsights: $ref: "#/components/schemas/detectionInsights" decisionInsights: $ref: "#/components/schemas/decisionInsightsAppend" passkeyAppendFinishReq: type: object required: - userID - processID - attestationResponse - clientInformation - trackingID properties: userID: description: ID of the user type: string processID: type: string attestationResponse: 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" sendNotification: type: boolean trackingID: type: string passkeyAppendFinishRsp: type: object required: - passkeyData properties: passkeyData: $ref: "#/components/schemas/passkeyData" passkeyLoginStartReq: type: object required: - userID - clientInformation - crossDeviceAuthenticationStrategy - processID properties: userID: description: ID of the user type: string clientInformation: $ref: "#/components/schemas/clientInformation" crossDeviceAuthenticationStrategy: $ref: "#/components/schemas/crossDeviceAuthenticationStrategy" processID: type: string passkeyLoginStartRsp: type: object required: - loginAllow - assertionOptions - detectionInsights - decisionInsights properties: loginAllow: type: boolean assertionOptions: type: string detectionInsights: $ref: "#/components/schemas/detectionInsights" decisionInsights: $ref: "#/components/schemas/decisionInsights" passkeyLoginFinishReq: type: object required: - userID - assertionResponse - clientInformation - processID - trackingID properties: userID: description: ID of the user type: string assertionResponse: type: string clientInformation: $ref: "#/components/schemas/clientInformation" processID: type: string signPasskeyData: type: boolean trackingID: type: string passkeyLoginFinishRsp: type: object required: - passkeyData properties: passkeyData: $ref: "#/components/schemas/passkeyData" signedPasskeyData: type: string ssoSaml2StartReq: type: object required: - email properties: email: type: string invitationToken: type: string ssoSaml2StartRsp: type: object required: - idpRedirectURL - ssoNonce properties: idpRedirectURL: type: string ssoNonce: type: string ssoSaml2FinishReq: type: object required: - samlResponse - relayState - ssoNonce properties: samlResponse: type: string relayState: type: string ssoNonce: type: string ssoSaml2FinishRsp: type: object required: - projectID - userID - identifier properties: projectID: description: ID of project type: string x-oapi-codegen-extra-tags: validate: required,id=pro userID: description: ID of the user type: string identifier: type: string invitationToken: type: string passkeyPostLoginReq: type: object required: - signedPasskeyData properties: signedPasskeyData: type: string passkeyPostLoginRsp: type: object required: - session properties: session: type: string passkeyVerifySignedDataReq: type: object required: - signedPasskeyData - username properties: signedPasskeyData: type: string username: type: string passkeyVerifySignedDataRsp: type: object required: - verificationResult properties: verificationResult: type: string enum: - "success" - "invalid_signature" - "invalid_challenge" - "user_mismatch" - "generic_error" passkeyMediationStartReq: type: object required: - clientInformation properties: clientInformation: $ref: "#/components/schemas/clientInformation" processID: type: string passkeyMediationStartRsp: type: object required: - loginAllow - assertionOptions properties: loginAllow: type: boolean assertionOptions: type: string passkeyMediationFinishReq: type: object required: - assertionResponse - clientInformation - processID - trackingID properties: assertionResponse: type: string clientInformation: $ref: "#/components/schemas/clientInformation" processID: type: string signPasskeyData: type: boolean trackingID: type: string passkeyMediationFinishRsp: type: object required: - passkeyData properties: passkeyData: $ref: "#/components/schemas/passkeyData" signedPasskeyData: type: string error: oneOf: - $ref: "#/components/schemas/passkeyMediationFinishErrorCredentialDeleted" - $ref: "#/components/schemas/passkeyMediationFinishErrorAlternativeProject" discriminator: propertyName: type mapping: credentialDeleted: "#/components/schemas/passkeyMediationFinishErrorCredentialDeleted" alternativeProjectID: "#/components/schemas/passkeyMediationFinishErrorAlternativeProject" passkeyMediationFinishErrorCredentialDeleted: type: object required: - type properties: type: type: string enum: - "credentialDeleted" passkeyMediationFinishErrorAlternativeProject: type: object required: - type - alternativeProjectName properties: type: type: string enum: - "alternativeProjectID" alternativeProjectName: type: string connectTokenCreateReq: type: object required: - type - data properties: type: $ref: "#/components/schemas/connectTokenType" data: $ref: "#/components/schemas/connectTokenData" maxLifetimeInSeconds: type: integer description: Maximum lifetime of the connectToken in seconds. example: 3600 connectTokenUpdateReq: type: object required: - status properties: status: $ref: "#/components/schemas/connectTokenStatus" webhookEndpointCreateReq: type: object required: - url - subscribedEvents - customHeaders properties: url: type: string basicAuthUsername: type: string basicAuthPassword: type: string subscribedEvents: type: array items: $ref: "#/components/schemas/webhookEventType" customHeaders: type: object webhookEndpointUpdateReq: type: object properties: url: type: string basicAuthUsername: type: string basicAuthPassword: type: string subscribedEvents: type: array items: $ref: "#/components/schemas/webhookEventType" customHeaders: type: object passkeyData: type: object required: - id - userID - username - ceremonyType - challengeID - aaguidDetails properties: id: type: string userID: type: string username: type: string ceremonyType: type: string enum: - "local" - "cda" - "security-key" challengeID: type: string aaguidDetails: $ref: "#/components/schemas/aaguidDetails" userVerified: type: boolean userPresent: type: boolean user: type: object required: - userID - status - updated - updatedMs properties: userID: type: string example: "usr-4693224802260150919" fullName: type: string example: "Jane Doe" status: $ref: "#/components/schemas/userStatus" explicitWebauthnID: type: string updated: type: string updatedMs: type: integer format: int64 userAggregate: type: object required: - userID - status - emailIdentifiers - phoneNumberIdentifiers - usernameIdentifiers - socialAccounts - created - createdMS - updated - updatedMs properties: userID: type: string example: "usr-4693224802260150919" fullName: type: string example: "Jane Doe" status: $ref: "#/components/schemas/userStatus" explicitWebauthnID: type: string emailIdentifiers: type: array items: $ref: '#/components/schemas/identifier' phoneNumberIdentifiers: type: array items: $ref: '#/components/schemas/identifier' usernameIdentifiers: type: array items: $ref: '#/components/schemas/identifier' socialAccounts: type: array items: $ref: '#/components/schemas/socialAccount' created: type: string createdMS: type: integer format: int64 updated: type: string updatedMs: type: integer format: int64 userList: type: object required: - users - paging properties: users: type: array items: $ref: "#/components/schemas/userAggregate" paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer sessionList: type: object required: - sessions - paging properties: sessions: type: array items: $ref: "#/components/schemas/session" paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer identifier: type: object required: - identifierID - type - value - status - userID properties: identifierID: type: string description: Unique identifier of the login identifier. example: "ide-4693224802260150919" type: $ref: "#/components/schemas/identifierType" value: type: string description: Value of the identifier (here email address). example: "jane@doe.com" status: $ref: "#/components/schemas/identifierStatus" userID: type: string description: Unique identifier of the user. example: "usr-4693224802260150919" identifierList: type: object required: - identifiers - paging properties: identifiers: type: array items: $ref: "#/components/schemas/identifier" paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer socialAccountCreateReq: type: object required: - providerType - identifierValue - foreignID - avatarURL - fullName properties: providerType: type: string description: Type of the social provider. enum: - 'google' - 'microsoft' - 'github' identifierValue: type: string description: Login identifier of the user (here email address). example: "jane@doe.com" foreignID: type: string description: Unique identifier of the user in the social provider. example: "53150919" avatarURL: type: string description: URL of the avatar of the user in the social provider. example: "https://avatars.githubusercontent.com/u/53150919?v=4" fullName: type: string description: Full name of the user in the social provider. example: "Jane Doe" socialAccount: type: object required: - socialAccountID - providerType - identifierValue - userID - foreignID - avatarURL - fullName properties: socialAccountID: type: string description: Unique identifier of the social account. example: "soc-6060375336139150919" providerType: type: string description: Type of the social provider. example: "github" identifierValue: type: string description: Login identifier of the user (here email address). example: "jane@doe.com" userID: type: string description: Unique identifier of the user. example: "usr-4693224802260150919" foreignID: type: string description: Unique identifier of the user in the social provider. example: "53150919" avatarURL: type: string description: URL of the avatar of the user in the social provider. example: "https://avatars.githubusercontent.com/u/53150919?v=4" fullName: type: string description: Full name of the user in the social provider. example: "Jane Doe" socialAccountList: type: object required: - socialAccounts - paging properties: socialAccounts: type: array items: $ref: "#/components/schemas/socialAccount" paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer credential: type: object required: - id - credentialID - attestationType - transport - backupEligible - backupState - authenticatorAAGUID - aaguidDetails - sourceOS - sourceBrowser - lastUsed - lastUsedMs - created - createdMs - status - tags properties: id: type: string example: "cre-12345" credentialID: type: string attestationType: type: string transport: type: array items: type: string enum: - "usb" - "nfc" - "ble" - "internal" - "hybrid" - "smart-card" backupEligible: type: boolean backupState: type: boolean authenticatorAAGUID: type: string sourceOS: type: string sourceBrowser: type: string lastUsed: type: string description: Timestamp of when the passkey was last used in yyyy-MM-dd'T'HH:mm:ss format lastUsedMs: type: integer format: int64 created: description: Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format type: string createdMs: type: integer format: int64 status: type: string enum: - "pending" - "active" description: "Status" aaguidDetails: $ref: "#/components/schemas/aaguidDetails" tags: type: array items: type: string aaguidDetails: type: object required: - aaguid - name - iconLight - iconDark properties: aaguid: type: string name: type: string iconLight: type: string iconDark: type: string credentialList: type: object required: - credentials - paging properties: credentials: type: array items: $ref: "#/components/schemas/credential" paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer fullCredential: type: object required: - credentialID - publicKey - authenticatorSignCount - authenticatorAAGUID - authenticatorAttachment - backupEligible - backupState - transports - attestationFormat - created - createdMs - status properties: credentialID: type: string description: Credential ID of the passkey, base64url encoded (without padding) publicKey: type: string description: Public key of the passkey, base64url encoded (without padding) authenticatorSignCount: type: integer format: int64 authenticatorAAGUID: type: string description: AAGUID of the authenticator, empty if unknown authenticatorAttachment: type: string enum: - "unknown" - "platform" - "cross-platform" backupEligible: type: boolean backupState: type: boolean transports: type: array items: type: string enum: - "usb" - "nfc" - "ble" - "internal" - "hybrid" - "smart-card" attestationFormat: type: string description: Attestation format of the passkey (for example `packed`, `apple` or `none`) created: description: Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format type: string createdMs: type: integer format: int64 status: type: string enum: - "active" description: "Status" fullCredentialList: type: object required: - fullCredentials properties: fullCredentials: type: array items: $ref: "#/components/schemas/fullCredential" challenge: type: object required: - challengeID - type - identifierValue - value - expires - status properties: challengeID: type: string type: $ref: "#/components/schemas/challengeType" identifierValue: type: string value: type: string expires: type: integer format: int64 status: $ref: "#/components/schemas/challengeStatus" authEventCreateReq: type: object required: - username - eventType - method - status - clientInformation properties: username: type: string eventType: $ref: "#/components/schemas/authEventType" method: $ref: "#/components/schemas/authEventMethod" status: $ref: "#/components/schemas/authEventStatus" clientInformation: $ref: "#/components/schemas/clientInformation" authEvent: type: object required: - authEventID - userID - username - eventType - method - created - createdMs - status properties: authEventID: type: string userID: description: ID of the user type: string username: type: string eventType: $ref: "#/components/schemas/authEventType" method: $ref: "#/components/schemas/authEventMethod" created: description: Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format type: string createdMs: type: integer format: int64 status: $ref: "#/components/schemas/authEventStatus" passkeyEventCreateReq: type: object required: - eventType properties: eventType: $ref: "#/components/schemas/passkeyEventType" expires: type: integer processID: type: string clientEnvID: type: string credentialID: type: string challenge: type: string passkeyEvent: type: object required: - passkeyEventID - userID - eventType - created - createdMs properties: passkeyEventID: type: string userID: description: ID of the user type: string eventType: $ref: "#/components/schemas/passkeyEventType" clientEnvID: type: string processID: type: string credentialID: type: string expires: type: integer created: description: Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format type: string createdMs: type: integer format: int64 passkeyEventList: type: object required: - passkeyEvents - paging properties: passkeyEvents: type: array items: $ref: "#/components/schemas/passkeyEvent" paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer projectConfigUpdateCnameReq: type: object required: - cname properties: cname: type: string detectionTag: type: object required: - category - name properties: category: type: string enum: - "support" - "clientEnv" - "history" - "passkey" name: type: string decisionTag: type: string enum: - env-no-platform-pk-support - env-no-pk-support - user-no-pks - user-login-blacklisted - user-security-key - user-positive-env-history - user-negative-env-history - env-blacklisted - user-platform-pk-high-confidence - user-cross-platform-pk-high-confidence - user-env-no-pks - default-deny - passkey-list-initiated-process - user-append-blacklisted - process-pk-login-sk-completed - process-pk-login-platform-completed - process-pk-login-not-offered - process-pk-login-incomplete - process-pk-login-cross-platform-completed - device-local-platform-passkey-experiment - env-broken - process-pk-login-aborted - env-password-manager-pk-experiment clientInformation: type: object required: - remoteAddress - userAgent - userVerifyingPlatformAuthenticatorAvailable - conditionalMediationAvailable - clientCapabilities - parsedDeviceInfo properties: remoteAddress: description: Client's IP address type: string example: "::ffff:172.18.0.1" userAgent: description: Client's user agent type: string example: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36" clientEnvHandle: description: Client's environment handle type: string javascriptFingerprint: description: Client's fingerprint type: string javaScriptHighEntropy: $ref: "#/components/schemas/javaScriptHighEntropy" bluetoothAvailable: description: Client's Bluetooth availability type: boolean passwordManagerAvailable: description: Client's password manager availability type: boolean userVerifyingPlatformAuthenticatorAvailable: type: boolean conditionalMediationAvailable: type: boolean clientCapabilities: $ref: "#/components/schemas/clientCapabilities" privateMode: type: boolean parsedDeviceInfo: $ref: "#/components/schemas/parsedDeviceInfo" nativeMeta: $ref: "#/components/schemas/nativeMeta" clientCapabilities: type: object properties: conditionalCreate: type: boolean conditionalMediation: type: boolean hybridTransport: type: boolean passkeyPlatformAuthenticator: type: boolean userVerifyingPlatformAuthenticator: type: boolean parsedDeviceInfo: type: object required: - browserName - browserVersion - osName - osVersion properties: browserName: type: string browserVersion: type: string osName: type: string osVersion: type: string nativeMeta: type: object required: - build properties: build: type: string deviceOwnerAuth: type: string isPlatformAuthenticatorAPISupported: type: boolean isBluetoothAvailable: type: boolean isBluetoothOn: type: boolean googlePlayServices: type: boolean deviceSecure: type: boolean brand: type: string model: type: string passkeyIntelFlags: type: object required: - forcePasskeyAppend properties: forcePasskeyAppend: type: boolean askForAutoAppend: type: boolean askForConditionalCreate: type: boolean askForInAppAppend: type: string javaScriptHighEntropy: type: object required: - platform - platformVersion - mobile properties: platform: type: string platformVersion: type: string mobile: type: boolean passkeyChallengeUpdateReq: type: object required: - status properties: status: $ref: "#/components/schemas/passkeyChallengeStatus" passkeyChallengeList: type: object required: - passkeyChallenges - paging properties: passkeyChallenges: type: array items: $ref: "#/components/schemas/passkeyChallenge" paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer passkeyChallenge: type: object required: - challengeID - type - value - status - created - createdMs - expires properties: challengeID: type: string type: $ref: "#/components/schemas/passkeyChallengeType" value: type: string status: $ref: "#/components/schemas/passkeyChallengeStatus" created: type: integer format: int64 createdMs: type: integer format: int64 expires: type: integer format: int64 passkeyChallengeType: type: string enum: - "register" - "authenticate" passkeyChallengeStatus: type: string enum: - "pending" - "completed" - "consumed" userStatus: type: string enum: - "pending" - "active" - "disabled" - "deleted" challengeType: type: string enum: - "email_otp" - "email_link" - "sms_otp" challengeStatus: type: string enum: - "pending" - "completed" - "expired" identifierType: type: string enum: - "email" - "phone" - "username" identifierStatus: type: string enum: - "pending" - "primary" - "verified" crossDeviceAuthenticationStrategy: type: string enum: - "standard" - "minimize" - "maximize" connectTokenStatus: type: string enum: - "initial" - "consumed" connectTokenType: type: string enum: - "passkey-append" - "passkey-delete" - "passkey-list" - "passkey-login" authEventMethod: type: string enum: - "password" - "email_otp" - "email_link" - "phone_otp" - "passkey" - "social_github" - "social_google" - "social_microsoft" authEventType: type: string enum: - "sign_up" - "login" - "new_passkey_added" authEventStatus: type: string enum: - "success" - "failure" webhookEventType: type: string enum: - "passkey-login.completed" - "passkey.created" - "passkey.deleted" - "user.created" - "user.updated" - "user.deleted" passkeyEventType: type: string enum: - user-login-blacklisted - login-explicit-abort - login-error - login-error-untyped - login-one-tap-switch - user-append-after-cross-platform-blacklisted - user-append-after-login-error-blacklisted - append-credential-exists - append-explicit-abort - append-error - login-no-credentials - manage-error - manage-credential-exists - manage-delete-explicit-abort connectToken: type: object required: - id - tokenType - data - connectTokenStatus - expires properties: id: type: string description: Unique identifier of the connectToken. example: "ctk-940364795071150919" tokenType: $ref: "#/components/schemas/connectTokenType" data: $ref: "#/components/schemas/connectTokenData" connectTokenStatus: $ref: "#/components/schemas/connectTokenStatus" secret: type: string description: Secret of the connectToken. example: "ctk1_sxmexzS7RFBaJSA4V4kBFPs45bkxMK" expires: type: integer description: Unix time of when the connectToken expires (in seconds elapsed since January 1, 1970, 00:00:00 UTC). example: 1752749184 connectTokenDataPasskeyAppend: type: object description: Data for `passkey-append`. required: - displayName - identifier properties: displayName: type: string description: Display name of the user. example: "Jane Doe" identifier: type: string description: Login identifier of the user (here email address). example: "jane@doe.com" connectTokenDataPasskeyDelete: type: object description: Data for `passkey-delete`. required: - identifier properties: identifier: type: string description: Login identifier of the user (here email address). example: "jane@doe.com" connectTokenDataPasskeyList: type: object description: Data for `passkey-list`. required: - identifier properties: identifier: type: string description: Login identifier of the user (here email address). example: "jane@doe.com" connectTokenDataPasskeyLogin: type: object description: Data for `passkey-login`. required: - identifier properties: identifier: type: string description: Login identifier of the user (here email address). example: "jane@doe.com" connectTokenData: type: object oneOf: - $ref: "#/components/schemas/connectTokenDataPasskeyAppend" - $ref: "#/components/schemas/connectTokenDataPasskeyDelete" - $ref: "#/components/schemas/connectTokenDataPasskeyList" - $ref: "#/components/schemas/connectTokenDataPasskeyLogin" connectTokenList: type: object required: - connectTokens - paging properties: connectTokens: type: array items: $ref: "#/components/schemas/connectToken" paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer webhookEndpointList: type: object required: - webhookEndpoints properties: webhookEndpoints: type: array items: $ref: "#/components/schemas/webhookEndpoint" webhookEndpoint: type: object required: - id - url - basicAuthUsername - basicAuthPassword - customHeaders - subscribedEvents - created - createdMs - updated - updatedMs properties: id: type: string url: type: string basicAuthUsername: type: string basicAuthPassword: type: string customHeaders: type: object subscribedEvents: type: array items: $ref: "#/components/schemas/webhookEventType" created: type: string createdMs: type: integer format: int64 updated: type: string updatedMs: type: integer format: int64 detectionInsights: type: object required: - tags - credentialIds - clientEnvIds - isCDACandidate - passwordManagerIds - historyData properties: tags: type: array items: $ref: "#/components/schemas/detectionTag" credentialIds: type: array items: type: string clientEnvIds: type: array items: type: string passwordManagerIds: type: array items: type: string historyData: $ref: "#/components/schemas/appendHistoryData" appendHistoryData: type: object required: - defaultCount - afterErrorCount - afterHybridCount - autoCount - defaultCooldown - afterErrorCooldown - afterHybridCooldown - autoCooldown - conditionalCreateCooldown - inAppCooldown properties: defaultCount: type: integer afterErrorCount: type: integer afterHybridCount: type: integer autoCount: type: integer defaultCooldown: type: boolean afterErrorCooldown: type: boolean afterHybridCooldown: type: boolean autoCooldown: type: boolean conditionalCreateCooldown: type: boolean inAppCooldown: type: boolean decisionInsights: type: object required: - tag - isCDACandidate - experiments properties: tag: $ref: "#/components/schemas/decisionTag" isCDACandidate: type: boolean experiments: type: array items: type: string preferImmediatelyAvailable: type: boolean decisionInsightsAppend: type: object required: - tag - isRestrictedBrowser - variant - auto - conditional properties: tag: $ref: "#/components/schemas/decisionTag" isRestrictedBrowser: type: boolean variant: type: string enum: - "default" - "after-error" - "after-hybrid" - "passkey-list" - "after-no-credential" - "in-app" auto: type: boolean conditional: type: boolean customData: type: object additionalProperties: type: string passwordManagerList: type: object required: - passwordManagers properties: passwordManagers: type: array items: $ref: "#/components/schemas/passwordManager" passwordManager: type: object required: - id - userID - clientEnvID - credentialID - aaguid - status - score - createdMs properties: id: type: string userID: type: string clientEnvID: type: string credentialID: type: string aaguid: type: string status: type: string score: type: integer createdMs: type: integer format: int64 clientEnvList: type: object required: - clientEnvs properties: clientEnvs: type: array items: $ref: "#/components/schemas/clientEnv" clientEnv: type: object required: - id - handle - browserName - browserVersion - osName - osVersion - userAgent - jsFingerprint - createdMs - clientType properties: id: type: string handle: type: string browserName: type: string browserVersion: type: string osName: type: string osVersion: type: string userAgent: type: string jsFingerprint: type: string createdMs: type: integer format: int64 deviceId: type: string clientType: type: string enum: - "web" - "app" description: Type of client (web or app) exportType: type: string enum: - credentials - connect-timeseries exportList: type: object required: - exports properties: exports: type: array items: $ref: "#/components/schemas/exportItem" exportItem: type: object required: - filename - size - checksum - created - createdMs properties: filename: type: string size: type: integer format: int64 description: File size in bytes checksum: type: string description: Checksum of the file created: type: string createdMs: type: integer format: int64 exportDownloadLink: type: object required: - link properties: link: type: string ConnectReadBackendStatsGetRsp: type: object required: - panel properties: panel: $ref: '#/components/schemas/ConnectReadBackendStatPanel' ConnectReadBackendStatPanel: type: object required: - values properties: values: type: array items: $ref: '#/components/schemas/ConnectReadBackendNamedValue' ConnectReadBackendNamedValue: type: object required: - name - value - dimensions properties: name: type: string value: type: number format: float dimensions: type: object additionalProperties: type: string ConnectReadBackendStatsByTimeGetRsp: type: object required: - panel properties: panel: $ref: '#/components/schemas/ConnectReadBackendTimeSeriesPanel' ConnectReadBackendTimeSeriesPanel: type: object required: - times - namedTimeSeries properties: times: type: array items: type: integer format: int64 namedTimeSeries: type: array items: $ref: '#/components/schemas/ConnectReadBackendNamedTimeSeries' ConnectReadBackendNamedTimeSeries: type: object required: - name - dimensions - values properties: name: type: string dimensions: type: object additionalProperties: type: string values: type: array items: type: number format: float ConnectReadBackendConnectApplicationListRsp: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendConnectApplication' ConnectReadBackendConnectApplication: type: object required: - id - projectID - name - clientType - clientIdentifier - createdMs properties: id: type: string projectID: type: string name: type: string clientType: type: string clientIdentifier: type: string osName: type: string createdMs: type: integer format: int64 ConnectReadBackendConnectProcessSearchReq: type: object required: - page properties: page: type: integer from: type: string example: '2006-01-02' to: type: string example: '2006-01-02' applicationID: type: string osName: type: string visitorCategory: type: string isWebView: type: boolean isBot: type: boolean minScore: type: integer loginOutcome: type: array items: type: string appendOutcome: type: array items: type: string manageOutcome: type: array items: type: string identifierAlternative: type: string identifier: type: string orderBy: type: string enum: - created - score x-enum-varnames: - ConnectReadBackendConnectProcessSearchReqPropertiesOrderbyCreated - ConnectReadBackendConnectProcessSearchReqPropertiesOrderbyScore hash: type: string loginCompleted: type: boolean pageSize: type: integer default: 100 loginInitiation: type: array items: type: string brand: type: string modelPrefix: type: string ConnectReadBackendConnectProcessSearchRsp: type: object required: - items - page properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendConnectProcess' page: type: integer ConnectReadBackendConnectProcess: type: object required: - processID - createdMs - clientInformation - eventCount - identifierDisplayName - visitorCategory - score properties: processID: type: string mainProcessID: type: string createdMs: type: integer format: int64 eventCount: type: integer format: int64 identifierDisplayName: type: string identifierAlternative: type: string identifierHashed: type: string userID: type: string clientType: type: string enum: - web - app - api description: API processes have no user-device context. x-enum-varnames: - ConnectReadBackendConnectProcessPropertiesClienttypeWeb - ConnectReadBackendConnectProcessPropertiesClienttypeApp - ConnectReadBackendConnectProcessPropertiesClienttypeApi clientInformation: $ref: '#/components/schemas/ConnectReadBackendClientInformation' visitorCategory: type: string enum: - user - manual-tester - auto-tester - not-calculated x-enum-varnames: - ConnectReadBackendConnectProcessPropertiesVisitorcategoryUser - ConnectReadBackendConnectProcessPropertiesVisitorcategoryManualtester - ConnectReadBackendConnectProcessPropertiesVisitorcategoryAutotester - ConnectReadBackendConnectProcessPropertiesVisitorcategoryNotcalculated score: type: integer format: int clientEnvID: type: string ConnectReadBackendClientInformation: type: object properties: browserString: type: string platformString: type: string isPasskeyReady: type: boolean isConditionalMediationAvailable: type: boolean bluetoothAvailable: type: boolean isPrivateMode: type: boolean ConnectReadBackendConnectProcessListReq: type: object required: - processIDs properties: processIDs: type: array items: type: string ConnectReadBackendConnectProcessListRsp: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendConnectProcess' ConnectReadBackendConnectProcessEventsGetRsp: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendConnectProcessEvent' ConnectReadBackendConnectProcessEvent: type: object required: - eventID - createdMs - eventType - eventData properties: eventID: type: string createdMs: type: integer format: int64 eventType: type: string eventData: type: string ConnectReadBackendConnectProcessMetadataGetRsp: type: object required: - data properties: data: $ref: '#/components/schemas/ConnectReadBackendConnectProcessMetadata' ConnectReadBackendConnectProcessMetadata: type: object description: contains additional (expensive) data for a connectprocess required: - processID - createdMs - rawClientInformation properties: processID: type: string createdMs: type: integer format: int64 rawClientInformation: type: string ConnectReadBackendConnectSubProcessListRsp: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendConnectSubProcess' ConnectReadBackendConnectSubProcess: type: object required: - id - createdMs - durationMs - score - outcome - data properties: id: type: string createdMs: type: integer format: int64 durationMs: type: integer format: int64 score: type: integer format: int64 outcome: type: string data: oneOf: - $ref: '#/components/schemas/ConnectReadBackendConnectSubProcessDataLogin' - $ref: '#/components/schemas/ConnectReadBackendConnectSubProcessDataAppend' - $ref: '#/components/schemas/ConnectReadBackendConnectSubProcessDataManage' discriminator: propertyName: type mapping: login: '#/components/schemas/ConnectReadBackendConnectSubProcessDataLogin' append: '#/components/schemas/ConnectReadBackendConnectSubProcessDataAppend' manage: '#/components/schemas/ConnectReadBackendConnectSubProcessDataManage' ConnectReadBackendConnectSubProcessDataLogin: type: object required: - type - errorCount - outcomeClassification - initiationClassification - ceremonyType - loginCompleted - retryCountPk properties: type: type: string enum: - login x-enum-varnames: - ConnectReadBackendConnectSubProcessDataLoginPropertiesTypeLogin errorCount: type: integer format: uint8 outcomeClassification: type: string initiationClassification: type: string ceremonyType: type: string loginCompleted: type: boolean retryCountPk: type: integer oneTapSource: type: string loginHint: type: string ConnectReadBackendConnectSubProcessDataAppend: type: object required: - type - errorCount - outcomeClassification - initiationClassification - ceremonyType properties: type: type: string enum: - append x-enum-varnames: - ConnectReadBackendConnectSubProcessDataAppendPropertiesTypeAppend errorCount: type: integer format: uint8 outcomeClassification: type: string initiationClassification: type: string ceremonyType: type: string completionType: type: string ConnectReadBackendConnectSubProcessDataManage: type: object required: - type - errorCount - outcomeClassification - situation - ceremonyType properties: type: type: string enum: - manage x-enum-varnames: - ConnectReadBackendConnectSubProcessDataManagePropertiesTypeManage errorCount: type: integer format: uint8 outcomeClassification: type: string situation: type: string description: passkey-list (Corbado component) or api (customer's own passkey management via Backend API) ceremonyType: type: string credentialsBefore: type: integer description: number of passkeys before the action (last list), missing if unknown credentialsAfter: type: integer description: number of passkeys after the action (refresh list), missing if unknown ConnectReadBackendConnectProcessErrorListRsp: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendConnectProcessError' ConnectReadBackendConnectProcessError: type: object required: - errorID - processID - clientType - osName - osVersion - technicalName - createdMs properties: errorID: type: string processID: type: string clientType: type: string osName: type: string osVersion: type: string technicalName: type: string createdMs: type: integer format: int64 eventType: type: string message: type: string ConnectReadBackendConnectProcessErrorPatternListRsp: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendConnectProcessErrorPattern' ConnectReadBackendConnectProcessErrorPattern: type: object required: - id - title - description - priority - severity - createdMs properties: id: type: string title: type: string pattern: type: string eventType: type: string description: type: string priority: type: integer severity: type: string enum: - expected - unexpected x-enum-varnames: - ConnectReadBackendConnectProcessErrorPatternPropertiesSeverityExpected - ConnectReadBackendConnectProcessErrorPatternPropertiesSeverityUnexpected createdMs: type: integer format: int64 ConnectReadBackendDeviceBatchListReq: type: object required: - userIDs properties: userIDs: type: array items: type: string minItems: 1 maxItems: 1000 description: List of user IDs to fetch devices for example: - usr-4693224802260150919 - usr-4693224802260150920 ConnectReadBackendDeviceBatchList: type: object required: - devices properties: devices: type: array items: $ref: '#/components/schemas/ConnectReadBackendDevice' ConnectReadBackendDevice: type: object required: - id - userID - osName - classification - classificationScore - totalLoginCount - passkeyLoginsCompleted - abortedPKLoginsCompletedCount - abortedPKLoginsIncompleteCount - pureConventionalLoginsCompleted - pureConventionalLoginsIncomplete - completedAppendCount - abortedAppendCount - nativeAppInstalled - createdMs - clientEnvIDs properties: id: type: string description: Unique identifier of the device example: ndv-4693224802260150919 userID: type: string description: ID of the user this device belongs to example: usr-4693224802260150919 osName: type: string description: Operating system name example: iOS classification: type: string enum: - unclear - missing-pk-support - append-avoided - login-avoided - append-completed - login-completed - login-completed-repeated - login-completed-with-interruption description: Device classification based on passkey usage patterns x-enum-varnames: - ConnectReadBackendDevicePropertiesClassificationUnclear - ConnectReadBackendDevicePropertiesClassificationMissingpksupport - ConnectReadBackendDevicePropertiesClassificationAppendavoided - ConnectReadBackendDevicePropertiesClassificationLoginavoided - ConnectReadBackendDevicePropertiesClassificationAppendcompleted - ConnectReadBackendDevicePropertiesClassificationLogincompleted - ConnectReadBackendDevicePropertiesClassificationLogincompletedrepeated - ConnectReadBackendDevicePropertiesClassificationLogincompletedwithinterruption classificationScore: type: integer description: Calculated score based on classification and login frequency example: 75 totalLoginCount: type: integer passkeyLoginsCompleted: type: integer abortedPKLoginsCompletedCount: type: integer abortedPKLoginsIncompleteCount: type: integer pureConventionalLoginsCompleted: type: integer pureConventionalLoginsIncomplete: type: integer completedAppendCount: type: integer abortedAppendCount: type: integer nativeAppInstalled: type: boolean description: Whether a native app client environment exists for this device createdMs: type: integer format: int64 description: Timestamp when this device was calculated clientEnvIDs: type: array items: type: string description: List of client environment IDs grouped into this device ConnectReadBackendSharedDeviceList: type: object required: - items properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendSharedDevice' ConnectReadBackendSharedDevice: type: object required: - userID - deviceID - clientEnvID properties: userID: type: string deviceID: type: string clientEnvID: type: string ConnectReadBackendAndroidAppConfigListRsp: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - rows - paging properties: rows: type: array items: $ref: '#/components/schemas/ConnectReadBackendAndroidAppConfigItem' paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer ConnectReadBackendAndroidAppConfigItem: type: object required: - id - projectID - packageName - fingerprint - base64URL - created - updated properties: id: type: string description: ID of Android app configuration example: and-abc123 projectID: description: ID of project type: string x-oapi-codegen-extra-tags: validate: required,id=pro packageName: type: string fingerprint: type: string base64URL: type: string created: description: Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format type: string updated: description: Timestamp of when the entity was last updated in yyyy-MM-dd'T'HH:mm:ss format type: string ConnectReadBackendPasskeyIntelligenceRulesetMetadataListRsp: type: object required: - items - paging properties: items: type: array items: $ref: '#/components/schemas/ConnectReadBackendPasskeyIntelligenceRulesetMetadata' paging: type: object required: - page - totalPages - totalItems properties: page: description: current page returned in response type: integer default: 1 totalPages: description: total number of pages available type: integer totalItems: description: total number of items available type: integer ConnectReadBackendPasskeyIntelligenceRulesetMetadata: type: object required: - isActive - projectID - rulesetID - type - version - createdMs properties: isActive: type: boolean rulesetID: type: string projectID: type: string version: type: integer type: type: string createdMs: type: string ConnectReadBackendPasskeyIntelligenceRulesetGetRsp: type: object required: - data properties: data: $ref: '#/components/schemas/ConnectReadBackendPasskeyIntelligenceRuleset' ConnectReadBackendPasskeyIntelligenceRuleset: type: object required: - content - metaData properties: content: type: string metaData: $ref: '#/components/schemas/ConnectReadBackendPasskeyIntelligenceRulesetMetadata' responses: error: description: Error content: application/json: schema: allOf: - type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 - type: object required: - error properties: data: type: object error: type: object required: - type properties: type: description: Type of error type: string details: description: Details of error type: string validation: description: Validation errors per field type: array items: type: object required: - field - message properties: field: type: string message: type: string links: description: Additional links to help understand the error type: array items: type: string "200": description: Operation succeeded. content: application/json: schema: type: object required: - httpStatusCode - message - requestData - runtime properties: httpStatusCode: description: HTTP status code of operation type: integer format: int32 message: type: string example: 'OK' requestData: description: Data about the request itself, can be used for debugging type: object required: - requestID properties: requestID: description: Unique ID of request, you can provide your own while making the request, if not the ID will be randomly generated on server side type: string example: 'req-557...663' link: description: Link to dashboard with details about request type: string example: 'https://my.corbado.com/requests/req-xxxxxxxxxxxxxxxxxxx' runtime: description: Runtime in seconds for this request type: number format: float example: 0.06167686 security: - basicAuth: [] - bearerAuth: []