Skip to main content

Manage tenant users

In this tutorial, you will learn how to add and remove tenant users using the EDK CLI, this lesson is applicable if you have been given a tenant_user_admin role within a tenant.

To get help with commands for managing users within tenants, you can use the edk tenant user --help command.

Usage: edk tenant user [options] [command]

manage tenant users

Options:
  -h, --help                display help for command

Commands:
  list [options]            list all tenant users
  add [options] <email>     add a user to a tenant
  remove [options] <email>  remove a user to a tenant
  help [command]            display help for command

List all tenant users

If you have been provided the tenant_user_admin role, you can list all users in the current tenant context by running edk tenant user list in the command-line. You can get help with the command by running edk tenant user list --help.

Run the following command:

edk tenant user list

Which will result in:

Users linked to tenant "MyTenant".


TENANTUSERUUID                       USERUUID                             USEREMAIL          CREATEDBY          CREATEDAT                DELETEDBY DELETEDAT
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX name1@email.com    name1@email.com    YYYY-MM-DDTHH:MM:SS.MSZ
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX name2@email.com    name1@email.com    YYYY-MM-DDTHH:MM:SS.MSZ
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX name3@email.com    name1@email.com    YYYY-MM-DDTHH:MM:SS.MSZ

Remove a user from a tenant

If you have been provided the tenant_user_admin role, you can remove a user from a tenant by running edk tenant user remove in the command-line along with the user email address. You can get help with the command by running edk tenant user remove --help.

Run the following command:

edk tenant user remove name2@email.com

Which will result in:

✔ Successfully unlinked user name2@email.com from tenant MyTenant

Add a user from to tenant

If you have been provided the tenant_user_admin role, you can add a user to a tenant by running edk tenant user add in the command-line along with the user email address. You can get help with the command by running edk tenant user add --help.

Run the following command:

edk tenant user add name2@email.com

Which will result in:

✔ Successfully linked user name2@email.com to tenant MyTenant

Next steps

In this tutorial you learnt how to manage users in a tenant, continue to the next tutorial to learn how to manage tenant roles.

On this page