Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Share and administer admin team

kater admin team invite

Invites people to your Kater organisation by email.

Each person gets an invitation email, and joins with the role and groups that you give. Anyone already invited or already a member is skipped.

Examples

Terminal window
# Invite one person as a viewer
kater admin team invite teammate@example.com
# Invite one person as a developer, into the Marketing group
kater admin team invite teammate@example.com --role developer --group Marketing
# Invite everyone in a CSV file
kater admin team invite --csv people.csv

Arguments

ArgumentDescription
<emails>Optional. The email addresses of the people to invite, such as teammate@example.com. Leave them out when you give --csv. Give one or more.

Options

OptionDescription
--role <role>The role of the people you name: admin, developer or viewer. The default is viewer.
--group <group>A group to add the people to, such as Marketing. Kater makes the group when it does not exist. You can give it more than one time.
--csv <file>A CSV file of people to invite, each with their own role, groups and attributes. See The CSV file.
--connection <connection>A connection they can use; repeat for more. The first is their default. Left out, the organisation’s one connection. You can give it more than one time.

It also takes the global options --json and --help.

The CSV file

The file starts with a header row of these columns: email, name, role, groups and attributes.

  • role is admin, developer or viewer. An empty role is viewer.
  • groups lists groups with a ; between them.
  • attributes gives each attribute as key=value, with a ; between them.
  • Kater makes each group, attribute and value that does not exist yet. It cannot set a system attribute, such as user_email.
people.csv
email,name,role,groups,attributes
teammate@example.com,Sam Lee,developer,Marketing;Finance,region=emea

What it prints

  • Each line gives an email address and what happened: invited, already invited or member. member means that the person is already a member.
  • A person who has an invitation already gets no second email.
  • A person’s groups and attributes apply the first time they sign in to Kater.
  • One command invites 500 people at most. An email address that repeats counts one time.

It needs the settings:manage permission.

See also