User commands - rossumai/elisctl GitHub Wiki

Create

Will create a new user in the organization. No associated queue (? might associate with the only queue in organization.)

elisctl user create USERNAME PASSWORD
123

ADVANCED:

  • --queue-id, -q: queue IDs to associate the user with (multiple ids allowed)
  • --all-queues: assign to all queues
  • --group, -g: permission group (one of admin, annotator (default) , viewer, multiple groups allowed)
  • --locale, -l: localization of Verification interface (one of en (default), cs)
  • --organization-id, -o: select an organization (useful only for superadmin

List

Shows table of users in organization. Does not show inactive (deleted) users.

elisctl user list

| id | username          | groups    | queues
|----|-------------------|-----------|-------
| 1  | [email protected]  | annotator | 1, 2
| 2  | [email protected] | admin     |

ADVANCED:

  • --all: shows also users that were deleted using delete command
  • --group-by: e.g. workspace, queue
  • filter: e.g. --workspace-id, --queue-id, --group

Delete

Disables user from Elis access (toggles flag is_active to false, but user is preserved in DB).

elisctl user delete ID --yes

Change

ADVANCED

elisctl user change ID
  • --queue-id, -q: queue IDs to associate the user with (multiple ids allowed). Original queues not preserved.
  • --group, -g: permission group (one of admin, annotator, viewer, multiple groups allowed). Original groups not preserved.
  • --locale, -l: localization of Verification interface (one of en (default), cs)
  • --username, -u
  • --password, -p (we should check if this actually works over API)

Reset password

elisctl user reset-password ID

It's not possible over API at the moment. Must be implemented.