One Logo Pool Ball
AuthenticationServices · IOS API REFERENCE

ASImportableCredential.Passkey

struct · iOS 26.0+ · SDK 27.1

struct Passkey

A representation of Passkey as defined in the [Credential Exchange Format (CXF) specs](https://fidoalliance.org/specs/cx/cxf-v1.0-rd-20250313.html) This represents a passkey credential.

Members (16)

get · iOS 26.0+

userHandle

TypeScript
get userHandle(): ArrayBuffer
Swift declaration
var userHandle: Data

The user handle associated with this passkey.

set · iOS 26.0+

userHandle

TypeScript
set userHandle(value: ArrayBuffer)
Swift declaration
var userHandle: Data

The user handle associated with this passkey.

get · iOS 26.0+

credentialID

TypeScript
get credentialID(): ArrayBuffer
Swift declaration
var credentialID: Data

The credential ID associated with this passkey.

set · iOS 26.0+

credentialID

TypeScript
set credentialID(value: ArrayBuffer)
Swift declaration
var credentialID: Data

The credential ID associated with this passkey.

init · iOS 26.4+

init

TypeScript
static initCredentialIDRelyingPartyIdentifierUserNameUserDisplayNameUserHandleKeyFido2Extensions(credentialID: ArrayBuffer, relyingPartyIdentifier: string, userName: string, userDisplayName: string, userHandle: ArrayBuffer, key: ArrayBuffer, fido2Extensions?: (ASImportableFIDO2Extensions) | null): ASImportableCredential_Passkey
Swift declaration
init(credentialID: Data, relyingPartyIdentifier: String, userName: String, userDisplayName: String, userHandle: Data, key: Data, fido2Extensions: ASImportableFIDO2Extensions?)
init · iOS 26.0+

init

TypeScript
static initCredentialIDRelyingPartyIdentifierUserNameUserDisplayNameUserHandleKey(credentialID: ArrayBuffer, relyingPartyIdentifier: string, userName: string, userDisplayName: string, userHandle: ArrayBuffer, key: ArrayBuffer): ASImportableCredential_Passkey
Swift declaration
init(credentialID: Data, relyingPartyIdentifier: String, userName: String, userDisplayName: String, userHandle: Data, key: Data)
get · iOS 26.4+

fido2Extensions

TypeScript
get fido2Extensions(): (ASImportableFIDO2Extensions) | null
Swift declaration
var fido2Extensions: ASImportableFIDO2Extensions?

The FIDO2 extensions associated with this passkey.

set · iOS 26.4+

fido2Extensions

TypeScript
set fido2Extensions(value: (ASImportableFIDO2Extensions) | null)
Swift declaration
var fido2Extensions: ASImportableFIDO2Extensions?

The FIDO2 extensions associated with this passkey.

get · iOS 26.0+

userDisplayName

TypeScript
get userDisplayName(): string
Swift declaration
var userDisplayName: String

The human readable name associated with this passkey.

set · iOS 26.0+

userDisplayName

TypeScript
set userDisplayName(value: string)
Swift declaration
var userDisplayName: String

The human readable name associated with this passkey.

get · iOS 26.0+

relyingPartyIdentifier

TypeScript
get relyingPartyIdentifier(): string
Swift declaration
var relyingPartyIdentifier: String

The relying party identifier associated with this passkey.

set · iOS 26.0+

relyingPartyIdentifier

TypeScript
set relyingPartyIdentifier(value: string)
Swift declaration
var relyingPartyIdentifier: String

The relying party identifier associated with this passkey.

get · iOS 26.0+

key

TypeScript
get key(): ArrayBuffer
Swift declaration
var key: Data

The private key associated with this passkey. Must be a PKCS#8 formatted byte string and Base64URL encoded when encoding to JSON.

set · iOS 26.0+

key

TypeScript
set key(value: ArrayBuffer)
Swift declaration
var key: Data

The private key associated with this passkey. Must be a PKCS#8 formatted byte string and Base64URL encoded when encoding to JSON.

get · iOS 26.0+

userName

TypeScript
get userName(): string
Swift declaration
var userName: String

The user name associated with this passkey. When instantiating from JSON, this property will be populated from the "username" field.

set · iOS 26.0+

userName

TypeScript
set userName(value: string)
Swift declaration
var userName: String

The user name associated with this passkey. When instantiating from JSON, this property will be populated from the "username" field.

Skipped declarations

No declarations were skipped in this snapshot.

All AuthenticationServices types →