Skip to main content

Tenant

Tenant commands manage organizational spaces within Atym Hub. Tenants are isolated environments for managing devices and resources. Use these commands to list, add, or remove tenants from an account, and to manage the users that belong to a tenant. The tenant resource has aliases tenant and tenants.

tenant list​

List tenants accessible to a user. If USER_ID is omitted, lists tenants for the current user.

Usage:
  atymctl tenant list [USER_ID] [flags]

Flags:
  -h, --help   help for list

tenant add​

Add a new tenant to the current account.

Usage:
  atymctl tenant add [flags]

Flags:
  -d, --description string   Description of the tenant
  -h, --help                 help for add
  -n, --name string          Name of the tenant

Required: --name.

tenant remove​

Remove a tenant from the current account.

Usage:
  atymctl tenant remove [TENANT_ID] [flags]

Flags:
  -h, --help   help for remove

Required: TENANT_ID.

Tenant Users​

tenant user manages the users that belong to a tenant. Subcommands have aliases user and users.

tenant user list​

List users in a tenant.

Usage:
  atymctl tenant user list [flags]

Flags:
  -h, --help              help for list
  -o, --page_offset int   Offset for paging
  -p, --page_size int     Total items returned (default 20)

tenant user show​

Show the details of a user in a tenant.

Usage:
  atymctl tenant user show [flags]

Flags:
  -h, --help             help for show
  -u, --user_id string   User Id

Required: --user_id.

tenant user add​

Add a user to a tenant. Requires admin-level access to the tenant.

Usage:
  atymctl tenant user add [flags]

Flags:
  -a, --admin            User admin access
  -e, --editor           User editor access
  -h, --help             help for add
  -u, --user_id string   User ID
  -v, --viewer           User viewer access

Required: --user_id and one of --admin, --editor, or --viewer.

tenant user remove​

Remove a user from a tenant.

Usage:
  atymctl tenant user remove [flags]

Flags:
  -h, --help             help for remove
  -u, --user_id string   User ID

Required: --user_id.