Skip to content

user_import importentry

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

Version

v1.3.2

items Type

object (ImportEntry)

items Properties

Property Type Required Nullable Defined by
user_id string Optional cannot be null User import
emails array Required cannot be null User import
username string Optional cannot be null User import
webauthn_credentials array Optional cannot be null User import
password object Required cannot be null User import
otp_secret object Required cannot be null User import
created_at string Optional cannot be null User import
updated_at string Optional cannot be null User import

user_id

UserID optional uuid.v4. If not provided a new one will be generated for the user

user_id

  • is optional

  • cannot be null

user_id Type

string

emails

Emails optional list of emails

emails

  • is required

  • cannot be null

emails Type

object[] (ImportEmail)

emails Constraints

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

username

Username optional username of the user

username

  • is optional

  • cannot be null

username Type

string

webauthn_credentials

WebauthnCredentials optional list of WebAuthn credentials of a user. Includes passkeys and MFA credentials.

webauthn_credentials

  • is optional

  • cannot be null

webauthn_credentials Type

object[] (Details)

password

Password optional password.

password

  • is required

  • cannot be null

password Type

object (Details)

otp_secret

OTPSecret optional TOTP secret for MFA.

otp_secret

  • is required

  • cannot be null

otp_secret Type

object (Details)

created_at

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

created_at

  • is optional

  • 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 user. Will be set to the import date if not provided.

updated_at

  • is optional

  • 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

Clone this wiki locally