This utility calls Orkes APIs to bulk onboard users by loading details from a CSV file. It will use credentials of an existing logged-in admin user rather than an application account.
- NodeJS
$ npm iSave the file as users.csv in the same directory.
| id | name | roles | groups |
|---|---|---|---|
| [email protected] | John Doe | user | Some Group, Other Group |
| [email protected] | Anne Smith | admin | Another Group |
| [email protected] | Martin Lee | user,metadata_manager | Another Group |
The roles and groups fields can include multiple items by separating them with commas.
The roles field can only comprise the following names (case insensitive):
ADMINUSERMETADATA_MANAGERWORKFLOW_MANAGERUSER_READ_ONLY
Login to the Orkes cluster as an admin user and click on the "Copy Token" button in the left navigation below the email address. Paste it into the console when entering the ORKES_TOKEN.
export ORKES_URI=https://your-cluster.orkesconductor.io/api
export ORKES_TOKEN=eyJh..vIQ$ node index.jsEnsure successful save for all entries:
==========================
Orkes Bulk User Onboarding
==========================
Reading CSV input from: users.csv
CSV file successfully processed: 3 rows read
User saved: John Doe ([email protected])
User saved: Anne Smith ([email protected])
User saved: Martin Lee ([email protected])$ node index.js offboardEnsure successful deletion for all entries:
===========================
Orkes Bulk User Offboarding
===========================
Reading CSV input from: users.csv
CSV file successfully processed: 3 rows read
User deleted: John Doe ([email protected])
User deleted: Anne Smith ([email protected])
User deleted: Martin Lee ([email protected])