Custom Data (CSV) Formatting Requirements

Last updated: October 8, 2024

Background

When you add a custom app (๐Ÿ“„ Adding a custom app) or import custom data ( ๐Ÿ“„ Adding custom data to your apps) to an existing app via a CSV upload or the Lumos API, there are certain requirements for formatting the data that you need to follow. This article breaks down those requirements in more detail.

Content

The upload serves as a "snapshot" of your account data. This means any data missing from the CSV will be treated as if it no longer exists, while existing data will be updated to reflect the information currently in the CSV.

Character formatting

The characters in an uploaded CSV must be in UTF-8ย format. If they are not, the upload will fail.

File size

The maximum allowed file size for an uploaded CSV isย 10 MB. If the file is larger than this, your upload will be rejected.

Required fields

When you upload account data, you must include one or both of the following field combinations.

  • Emailย OR

  • First Name ANDย Last Name

If a row is missing one of these required elements, your upload will fail.

Email isย strongly recommended, as it ensures that employees with identical first + last names are matched correctly.

Account Status

Theย Status column in the data you provide has to match one of the following values.

  • DISCOVERED

  • STAGED

  • ACCESS_CREATED

  • ACTIVE

  • SUSPENDED

  • DEPROVISIONED

  • ARCHIVED

  • MANUALLY_REMOVED

  • ACCESS_REMOVED

  • NON_CORPORATE_ACCOUNT

  • WAITING_MANUAL_REMOVAL

If you provide an invalid value, your upload will fail.

If you provide no value or omit this column, it's assumed that the status of any accounts being uploaded is ACTIVE.