Skip to content

user_import importentry properties webauthn_credentials items

GitHub Action edited this page Jan 8, 2025 · 3 revisions

Version

v1.3.2

items Type

object (Details)

items Properties

Property Type Required Nullable Defined by
id string Required cannot be null User import
name string Required cannot be null User import
public_key string Required cannot be null User import
attestation_type string Required cannot be null User import
aaguid array Required cannot be null User import
sign_count integer Required cannot be null User import
last_used_at string Required cannot be null User import
created_at string Required cannot be null User import
updated_at string Required cannot be null User import
transports array Required cannot be null User import
backup_eligible boolean Required cannot be null User import
backup_state boolean Required cannot be null User import
mfa_only boolean Required cannot be null User import
user_handle string Required cannot be null User import

id

ID of the WebAuthn credential.

id

  • is required

  • cannot be null

id Type

string

name

Optional Name of the WebAuthn credential.

name

  • is required

  • cannot be null

name Type

string

public_key

The PublicKey of the credential.

public_key

  • is required

  • cannot be null

public_key Type

string

attestation_type

The AttestationType the credential was created with.

attestation_type

  • is required

  • cannot be null

attestation_type Type

string

aaguid

Optional AAGUID of the authenticator on which the credential was created on.

aaguid

  • is required

  • cannot be null

aaguid Type

integer[]

aaguid Constraints

maximum number of items: the maximum number of items for this array is: 16

minimum number of items: the minimum number of items for this array is: 16

sign_count

Optional SignCount of the WebAuthn credential.

sign_count

  • is required

  • cannot be null

sign_count Type

integer

last_used_at

LastUsedAt optional timestamp when the WebAuthn credential was last used.

last_used_at

  • is required

  • cannot be null

  • format: date-time

last_used_at Type

string

last_used_at Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

created_at

CreatedAt optional timestamp of the WebAuthn credentials' creation. Will be set to the import date if not provided.

created_at

  • is required

  • cannot be null

  • format: date-time

created_at Type

string

created_at Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

updated_at

UpdatedAt optional timestamp of the last update to the WebAuthn credential. Will be set to the import date if not provided.

updated_at

  • is required

  • cannot be null

  • format: date-time

updated_at Type

string

updated_at Constraints

date time: the string must be a date time string, according to RFC 3339, section 5.6

transports

Optional list of supported Transports by the authenticator.

transports

  • is required

  • cannot be null

transports Type

string[]

backup_eligible

BackupEligible flag indicates if the WebAuthn credential can be backed up (e.g. in Apple KeyChain, ...). If the information is not available set it to false.

backup_eligible

  • is required

  • cannot be null

backup_eligible Type

boolean

backup_state

BackupState flag indicates if the WebAuthn credential is backed up (e.g. in Apple KeyChain, ...). If the information is not available set it to false.

backup_state

  • is required

  • cannot be null

backup_state Type

boolean

mfa_only

MFAOnly flag indicates if the WebAuthn credential can only be used in combination with another login factor (e.g. password, ...).

mfa_only

  • is required

  • cannot be null

mfa_only Type

boolean

user_handle

UserHandle optional user id which was used to create the credential with. Populate only when user id was not an uuid v4 and the WebAuthn credential is not an MFAOnly credential.

user_handle

  • is required

  • cannot be null

user_handle Type

string

Clone this wiki locally