Skip to content

docs: update renamed deviceauthn fields references#2692

Open
pcaillaudm wants to merge 2 commits into
masterfrom
pcaillaudm/update-android-ios-docs
Open

docs: update renamed deviceauthn fields references#2692
pcaillaudm wants to merge 2 commits into
masterfrom
pcaillaudm/update-android-ios-docs

Conversation

@pcaillaudm

@pcaillaudm pcaillaudm commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

This PR updates the device authentication (deviceauthn) documentation to match the renamed settings-flow API fields.

Changes:

  • Key registration: the add payload field is renamed to deviceauthn_register, and the SDK
    model UpdateSettingsFlowWithDeviceAuthnMethodAdd is now
    UpdateSettingsFlowWithDeviceAuthnMethodRegister (method.addmethod.deviceauthnRegister).
  • Key removal: the delete object with a nested client_key_id is replaced by a flat
    deviceauthn_remove string field, removing the need for the
    UpdateSettingsFlowWithDeviceAuthnMethodDelete wrapper in the SDKs.
  • The Android and iOS registration examples now include the required version: 1 field,
    aligning them with the payload reference in the overview page.

All JSON payloads, Kotlin/Swift SDK snippets, and prose references to the old field names
were updated accordingly.

@unatasha8

Copy link
Copy Markdown
Contributor

Isn't renaming fields in the API something that can break customer code? Have we added a note or given some heads up beyond updating the docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants