Contents x
    Export users
    • 13 Jun 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Export users

    • Updated on 13 Jun 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    • Applies to: All Board Cloud subscriptions

    To bulk export users to a CSV file, you can use the Export feature.

    WHAT: Export file format and information

    This feature exports all Users details, metadata, and authorization to a CSV (Comma Separated Value) file with commas as delimiters. The first row of the file contains column headers.

    The following values are exported:

    Header name

    Description

    Example

    UserName

    Jeffconnors

    DisplayName

    Jeff Connors

    Email

    • Text in email format

    • Refers to the "Name" field in the Users profile panel

    jeff@acme.com

    PhoneNumber

    +1 0986 546 554 

    Role

    • Text

    • Refers to the "Role" column of the PLATFORM AUTHORIZATIONS table in the Users' profile panel.
      Roles are configured in Board Platforms (the "Admin" role is available out of the box)

    admin

    InstanceName

    • Text

    • Refers to the "Instance" column of the PLATFORM AUTHORIZATIONS table in the Users' profile panel

    xxxxxxxxx.board.com

    isAdmin

    • Boolean

    • Refers to the Platform specified in the same row

    TRUE

    FALSE

    UserLicense

    Power User

    BoardAuthentication

    • Boolean

    TRUE

    FALSE

    PermissionGroup

    Permission Group A

    License

    developer

    power user

    user

    lite

    mobile

    user 15

    isshadmin

    • Boolean

    TRUE

    FALSE

    msofficeenabled

    • Boolean

    • Refers to the MS-Office Add-in license activation status

    TRUE

    FALSE

    culture

    • Text

    • Refers to the "Culture" field in the Users' profile panel

    • Syntax examples: en-US, en-CA, es-ES, it-IT

    • A list of localization codes and tags can be found here

    xx-yy

    pswneverexpiresenabled

    • Boolean

    • Refers to the "Password never expires" checkbox in the Users' profile panel. The checkbox is only visible to users with Board authentication


    lastLogin

    1/25/2023; 9:54:00 AM

    disabled

    • Boolean

    TRUE

    FALSE

    enrollmentStatus

    COMPLETED

    [custom metadata field name]

    San Francisco

    Please note:

    • If a user is associated to multiple platforms, he/she will have one row of values for each platform

    • The exported details are always at the user level. If a Permission Group is assigned to a user, the values in the exported file may not reflect the actual settings active for that user in the Board environment

    • Client API Users are also exported.

    HOW: Export users to a CSV file

    1. To export the user list list to a .csv file, click on "EXPORT" in the upper left corner of the page

    2. The CSV file will be created on the fly and the download process will start automaticall

    Was this article helpful?
    What's Next