For the complete documentation index, see llms.txt. This page is also available as Markdown.

Rename Passkey

Membership · Passkey.

These endpoints power passwordless sign-in (passkeys / WebAuthn) and account recovery (magic links, recovery codes, email verification) for your app's end users.

Renames the passkey.

Membership · Passkey

post
Authorizations
HTTPRequired

JWT Bearer Authorization

Path parameters
VersionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

CredentialIdstring · nullableRequired

Base64 credential id of the passkey to rename, from list_passkeys.

Body

Membership · Passkey

correlationIdstringOptional

CorrelationId for each request

cultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstringOptional

TimeZone

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

envstringOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

friendlyNamestring · nullableRequired

The new friendly name for the passkey.

Responses
200

Success

application/json

PasskeyOkResponse

post/{version}/membership/userauth/passkeys/{CredentialId}/rename
POST /{version}/membership/userauth/passkeys/{CredentialId}/rename HTTP/1.1
Host: api.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 136

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "friendlyName": "text",
  "version": "text"
}
200

Success

{
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Membership.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Rename Passkey in the SDK reference, with examples in every language.

Last updated

Was this helpful?