Unlock seamless workflows and faster delivery with our latest releases - Join the deep dive

Users

Manage users of your project

usage: sanity users [--default] [-v|--version] [-d|--debug] [-h|--help] <command> [<args>]

Commands:
   invite  Invite a new user to the project
   list    List all users of the project

See 'sanity help users <command>' for specific information on a subcommand.

Commands

Invite

usage: sanity users invite [EMAIL]

   Invite a new user to the project

Options
  --role Role to invite the user as

Examples
  # Invite a new user to the project (prompt for details)
  sanity users invite

  # Send a new user invite to the email "pippi@sanity.io", prompt for role
  sanity users invite pippi@sanity.io

  # Send a new user invite to the email "pippi@sanity.io", as administrator
  sanity users invite pippi@sanity.io --role administrator

List

usage: sanity users list

   List all users of the project

Options
  --no-invitations Don't include pending invitations
  --no-robots Don't include robots (token users)
  --sort <field> Sort users by specified column: id, name, role, date
  --order <asc/desc> Sort output ascending/descending

Examples
  # List all users of the project
  sanity users list

  # List all users of the project, but exclude pending invitations and robots
  sanity users list --no-invitations --no-robots

  # List all users, sorted by role
  sanity users list --sort role

Was this article helpful?