Skip to main content

Account

Account commands help you list and view Atym Hub accounts and manage the users associated with them. The account resource has aliases account and accounts.


account list

List accounts associated with a user. If no USER_ID is provided, lists accounts for the current user.

Usage:
atymctl account list [USER_ID] [flags]

Flags:
-h, --help help for list

account show

Show detailed information about an account, including its associated tenants and users.

Usage:
atymctl account show [ACCOUNT_ID] [flags]

Flags:
-h, --help help for show

Note: If ACCOUNT_ID is omitted, the current account scope is used.


Account Users

Use account user to manage the users that belong to an account. Subcommands have aliases user and users.

account user list

List users in an account.

Usage:
atymctl account 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)

account user show

Show the details of a user in an account.

Usage:
atymctl account user show [flags]

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

Required: --user_id.


account user add

Add a user to an account. Requires admin-level access to the account.

Usage:
atymctl account 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.


account user remove

Remove a user from an account.

Usage:
atymctl account user remove [flags]

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

Required: --user_id.