From 20cc0daaeadc4d9dcb0c57fc241441ea8c78a93c Mon Sep 17 00:00:00 2001 From: Dhruv Pareek Date: Thu, 30 Apr 2026 16:10:31 -0700 Subject: [PATCH] [grid] Document passkey nickname validation --- mintlify/openapi.yaml | 4 ++-- openapi.yaml | 4 ++-- openapi/components/schemas/auth/AuthMethod.yaml | 4 ++-- .../schemas/auth/PasskeyCredentialCreateRequestFields.yaml | 7 +++++-- 4 files changed, 11 insertions(+), 8 deletions(-) diff --git a/mintlify/openapi.yaml b/mintlify/openapi.yaml index 7e969011..3bb1f87a 100644 --- a/mintlify/openapi.yaml +++ b/mintlify/openapi.yaml @@ -13814,7 +13814,7 @@ components: $ref: '#/components/schemas/AuthMethodType' 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 nickname provided at registration time. + 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. example: example@lightspark.com createdAt: type: string @@ -13932,7 +13932,7 @@ components: description: Discriminator value identifying this as a passkey credential. nickname: type: string - description: Human-readable identifier for the passkey, chosen by the user at registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Shown back on `AuthMethod` responses and in credential listings. + description: 'Human-readable identifier for the passkey, chosen by the user at registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Leading and trailing whitespace is ignored. Must be 1-100 characters and may contain Unicode letters, numbers, spaces, and the following separators: period, underscore, hyphen, apostrophe, and parentheses. Shown back on AuthMethod responses and in credential listings.' example: iPhone Face-ID challenge: type: string diff --git a/openapi.yaml b/openapi.yaml index 7e969011..3bb1f87a 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -13814,7 +13814,7 @@ components: $ref: '#/components/schemas/AuthMethodType' 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 nickname provided at registration time. + 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. example: example@lightspark.com createdAt: type: string @@ -13932,7 +13932,7 @@ components: description: Discriminator value identifying this as a passkey credential. nickname: type: string - description: Human-readable identifier for the passkey, chosen by the user at registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Shown back on `AuthMethod` responses and in credential listings. + description: 'Human-readable identifier for the passkey, chosen by the user at registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Leading and trailing whitespace is ignored. Must be 1-100 characters and may contain Unicode letters, numbers, spaces, and the following separators: period, underscore, hyphen, apostrophe, and parentheses. Shown back on AuthMethod responses and in credential listings.' example: iPhone Face-ID challenge: type: string diff --git a/openapi/components/schemas/auth/AuthMethod.yaml b/openapi/components/schemas/auth/AuthMethod.yaml index e3534628..1c955e8a 100644 --- a/openapi/components/schemas/auth/AuthMethod.yaml +++ b/openapi/components/schemas/auth/AuthMethod.yaml @@ -22,8 +22,8 @@ properties: 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 nickname - provided at registration time. + claim from the OIDC token; for PASSKEY credentials it is the validated + nickname provided at registration time. example: example@lightspark.com createdAt: type: string diff --git a/openapi/components/schemas/auth/PasskeyCredentialCreateRequestFields.yaml b/openapi/components/schemas/auth/PasskeyCredentialCreateRequestFields.yaml index 0379a1b8..805c8641 100644 --- a/openapi/components/schemas/auth/PasskeyCredentialCreateRequestFields.yaml +++ b/openapi/components/schemas/auth/PasskeyCredentialCreateRequestFields.yaml @@ -14,8 +14,11 @@ properties: type: string description: >- Human-readable identifier for the passkey, chosen by the user at - registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Shown - back on `AuthMethod` responses and in credential listings. + registration time (e.g. "iPhone Face-ID", "YubiKey 5C"). Leading + and trailing whitespace is ignored. Must be 1-100 characters and may + contain Unicode letters, numbers, spaces, and the following separators: + period, underscore, hyphen, apostrophe, and parentheses. Shown back on + AuthMethod responses and in credential listings. example: iPhone Face-ID challenge: type: string