Skip to content

actionxm users

Manage users in your organization.

actionxm users list

List all users in your organization.

bash
actionxm users list

Example:

bash
$ actionxm users list
Name           Email               Role     ID
─────────────────────────────────────────────────────────
Alice Johnson  alice@acme.com      admin    a1b2c3d4-...
Bob Smith      bob@acme.com        member   e5f6g7h8-...

Showing 2 user(s).

Exit codes:

  • 0 — Users listed successfully
  • 1 — Not authenticated, insufficient permissions, or API error

actionxm users create

Add a new user to your organization. An invitation email is sent to the new user.

bash
actionxm users create --email <email> --name <name> --role <role> --password <password>

Options:

FlagDescription
--email <email>Required. User email address
--name <name>Required. User display name
--role <role>Required. Role: admin, member, manager, or agent
--password <password>Required. Initial password (min 8 characters)

Validation:

  • Email must be globally unique
  • Password must be at least 8 characters
  • Role must be one of: admin, member, manager, agent

Example:

bash
$ actionxm users create --email bob@acme.com --name "Bob Smith" --role member --password "securepass123"
 User created: Bob Smith
  Email: bob@acme.com
  Role:  member
  ID:    e5f6g7h8-...

An invitation email has been sent to the user.

The new user will receive an invitation email with instructions to access the platform.

Exit codes:

  • 0 — User created successfully
  • 1 — Validation error, duplicate email, or API error

actionxm users edit

Edit a user in your organization.

bash
actionxm users edit <user-id> [--name <name>] [--role <role>] [--password <password>]

Arguments:

ArgumentDescription
<user-id>Required. UUID of the user to edit

Options:

FlagDescription
--name <name>New display name
--role <role>New role: admin, member, manager, or agent
--password <password>New password (min 8 characters)

At least one of --name, --role, or --password must be provided.

Restrictions:

  • You cannot change your own role

Example:

bash
$ actionxm users edit e5f6g7h8-... --role manager
 User updated: Bob Smith
  Email: bob@acme.com
  Role:  manager
  ID:    e5f6g7h8-...

Exit codes:

  • 0 — User updated successfully
  • 1 — User not found, validation error, or API error

actionxm users remove

Remove (deactivate) a user from your organization.

bash
actionxm users remove <user-id> [--confirm]

Arguments:

ArgumentDescription
<user-id>Required. UUID of the user to remove

Options:

FlagDescription
--confirmSkip confirmation prompt

Restrictions:

  • You cannot remove yourself
  • You cannot remove the last admin of a tenant

Example:

bash
$ actionxm users remove e5f6g7h8-...
Are you sure you want to remove user e5f6g7h8-...? (y/N): y
 User e5f6g7h8-... removed.

With --confirm flag (useful for scripting):

bash
$ actionxm users remove e5f6g7h8-... --confirm
 User e5f6g7h8-... removed.

Exit codes:

  • 0 — User removed successfully
  • 1 — User not found, not authenticated, or API error

ActionXM Analytics Platform