diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index dcadafc8..e82a2265 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -3910,7 +3910,7 @@ paths: $ref: '#/components/schemas/AuthCredentialListResponse' 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 @@ -3919,9 +3919,16 @@ paths: 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' @@ -15438,6 +15445,10 @@ components: example: InternalAccount:019542f5-b3e7-1d02-0000-000000000002 type: $ref: '#/components/schemas/AuthMethodType' + credentialId: + type: string + description: Base64url-encoded WebAuthn credential identifier for this passkey. Present only for `PASSKEY` authentication credentials. 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 nickname: type: string description: Human-readable identifier for this credential. For EMAIL_OTP credentials this is the email address; for OAUTH credentials it is typically the email claim from the OIDC token; for PASSKEY credentials it is the validated nickname provided at registration time. diff --git a/openapi.yaml b/openapi.yaml index dcadafc8..e82a2265 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -3910,7 +3910,7 @@ paths: $ref: '#/components/schemas/AuthCredentialListResponse' 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 @@ -3919,9 +3919,16 @@ paths: 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' @@ -15438,6 +15445,10 @@ components: example: InternalAccount:019542f5-b3e7-1d02-0000-000000000002 type: $ref: '#/components/schemas/AuthMethodType' + credentialId: + type: string + description: Base64url-encoded WebAuthn credential identifier for this passkey. Present only for `PASSKEY` authentication credentials. 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 nickname: type: string description: Human-readable identifier for this credential. For EMAIL_OTP credentials this is the email address; for OAUTH credentials it is typically the email claim from the OIDC token; for PASSKEY credentials it is the validated nickname provided at registration time. diff --git a/openapi/components/schemas/auth/AuthMethod.yaml b/openapi/components/schemas/auth/AuthMethod.yaml index 1c955e8a..8b73f0b6 100644 --- a/openapi/components/schemas/auth/AuthMethod.yaml +++ b/openapi/components/schemas/auth/AuthMethod.yaml @@ -17,6 +17,14 @@ properties: example: InternalAccount:019542f5-b3e7-1d02-0000-000000000002 type: $ref: ./AuthMethodType.yaml + credentialId: + type: string + description: >- + Base64url-encoded WebAuthn credential identifier for this passkey. + Present only for `PASSKEY` authentication credentials. 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 nickname: type: string description: >- diff --git a/openapi/paths/auth/auth_credentials.yaml b/openapi/paths/auth/auth_credentials.yaml index 1e8c1117..f60cb266 100644 --- a/openapi/paths/auth/auth_credentials.yaml +++ b/openapi/paths/auth/auth_credentials.yaml @@ -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 @@ -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'