The CSV file should contain a list of the users you want to import. The user attributes are described in the following table:

Attribute

Description

name.given

A string that specifies the given name of the user, or first name in most Western languages (for example, ‘Barbara’ given the full name ‘Ms. Barbara J Jensen, III’). Valid characters consists of any Unicode letter, mark (for example, accent, umlaut), space, dot, apostrophe, or hyphen. The value can have a length of no more than 256 characters.

name.family

A string that specifies the family name of the user, or last name in most Western languages (for example, ‘Jensen’ given the full name ‘Ms. Barbara J Jensen, III’). Valid characters consists of any Unicode letter, mark (for example, accent, umlaut), space, dot, apostrophe, or hyphen. The value can have a length of no more than 256 characters.

primaryPhone

A string that specifies the user’s primary phone number, which is optional by default. This value can match the mobilePhone attribute. If provided, the value must consist of a leading plus sign, 1 to 3-digit country code, dot separator, 4 to 14-digit phone number, and optional 1 to 8-digit extension (for example, +1.3034682900x1234).

mobilePhone

A string that specifies the user’s mobile phone number, which is optional by default. This value can match the primaryPhone attribute. If provided, the value must consist of a leading plus sign, 1 to 3-digit country code, dot separator, 4 to 14-digit phone number, and optional 1 to 8-digit extension (for example, +1.3034682900x1234).

email

A string that specifies the user’s email address, which is required by default. The value must be a valid email address.

username

A string that specifies the user name, which is required by default and must be unique within an environment. The value must be a well-formed email address or a string of any Unicode letter, mark (for example, accent, umlaut), dot, underscore, or hyphen. The value can have a length of no more than 128 characters.

password

A string that specifies the user's password. The password can be clear text or pre-encoded. Clear text passwords are evaluated against the current password policy. Pre-encoded passwords are not evaluated against the password policy, and they are specified by the name of the encoding scheme followed by an encoded representation of the password, as shown in the following example.

{SSHA512}UkGWfORubNKFpFBWh+Lgy4FrciclzUXneuryV+B+zBDR4Gqd5wvMqAvKRixgQWoZlZUgq8Wh40uMK3s6bWpzWt1/TqQH02hX

PingOne supports the following encoding schemes:

  • bcrypt {BCRYPT}
  • scrypt {SCRYPT}
  • PBKDF2 {PBKDF2}
  • salted SHA1 {SSHA}
  • salted SHA256 {SSHA256}
  • salted SHA384 {SSHA384}
  • salted SHA512 {SSHA512}

enabled

A boolean value that determines whether the user account should be enabled after it is imported. The value can be true or false.