Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 45 additions & 8 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 45 additions & 8 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions openapi/components/schemas/auth/AuthCredentialListItem.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
title: Auth Credential List Item
description: >-
Authentication credential returned from `GET /auth/credentials`. Passkey
credentials include the WebAuthn `credentialId` needed to target a specific
registered passkey; other credential types use the base `AuthMethod` shape.
oneOf:
- $ref: ./AuthMethodResponse.yaml
- $ref: ./PasskeyAuthMethod.yaml
discriminator:
propertyName: type
mapping:
EMAIL_OTP: ./AuthMethodResponse.yaml
OAUTH: ./AuthMethodResponse.yaml
PASSKEY: ./PasskeyAuthMethod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ properties:
type: array
description: List of authentication credentials registered on the internal account.
items:
$ref: ./AuthMethod.yaml
$ref: ./AuthCredentialListItem.yaml
24 changes: 24 additions & 0 deletions openapi/components/schemas/auth/PasskeyAuthMethod.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
title: Passkey Auth Method
description: >-
Authentication credential response for a PASSKEY auth method. Extends the
base `AuthMethod` shape with the WebAuthn credential identifier needed by
clients to target this passkey in `navigator.credentials.get()`.
allOf:
- $ref: ./AuthMethod.yaml
- type: object
required:
- credentialId
properties:
type:
type: string
enum:
- PASSKEY
description: Discriminator value identifying this as a passkey credential.
credentialId:
type: string
description: >-
Base64url-encoded WebAuthn credential identifier for this passkey.
Corresponds to `PublicKeyCredential.rawId`; pass this value as
`allowCredentials[].id` when requesting a passkey assertion for this
auth method.
example: KEbWNCc7NgaYnUyrNeFGX9_3Y-8oJ3KwzjnaiD1d1LVTxR7v3CaKfCz2Vy_g_MHSh7yJ8yL0Pxg6jo_o0hYiew
9 changes: 8 additions & 1 deletion openapi/paths/auth/auth_credentials.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ get:
$ref: ../../components/schemas/auth/AuthCredentialListResponse.yaml
examples:
multipleCredentials:
summary: Internal account with an email OTP and a passkey credential
summary: Internal account with multiple authentication credentials
value:
data:
- id: AuthMethod:019542f5-b3e7-1d02-0000-000000000001
Expand All @@ -237,9 +237,16 @@ get:
nickname: example@lightspark.com
createdAt: '2026-04-08T15:30:01Z'
updatedAt: '2026-04-08T15:30:01Z'
- id: AuthMethod:019542f5-b3e7-1d02-0000-000000000004
accountId: InternalAccount:019542f5-b3e7-1d02-0000-000000000002
type: OAUTH
nickname: example@lightspark.com
createdAt: '2026-04-08T15:35:00Z'
updatedAt: '2026-04-08T15:35:00Z'
- id: AuthMethod:019542f5-b3e7-1d02-0000-000000000003
accountId: InternalAccount:019542f5-b3e7-1d02-0000-000000000002
type: PASSKEY
credentialId: KEbWNCc7NgaYnUyrNeFGX9_3Y-8oJ3KwzjnaiD1d1LVTxR7v3CaKfCz2Vy_g_MHSh7yJ8yL0Pxg6jo_o0hYiew
nickname: iPhone Face-ID
createdAt: '2026-04-09T10:15:00Z'
updatedAt: '2026-04-09T10:15:00Z'
Expand Down
Loading