Skip to main content

Authentication

This section explains how to authenticate with the Atym Hub via the Atym CLI.

login​

Authenticates the user with the Atym Hub.

Usage:
  atym login [flags]

Flags:
  -a, --accountscope         Set account scope
  -m, --admin                Set admin role
  -y, --atymadmin            Set atym admin role
  -z, --atymid string        resource id for the atym admin token
  -d, --editor               Set editor role
  -e, --environment string   Atym environment to use
  -h, --help                 help for login
  -n, --nobrowser            Do not open browser for authentication
  -r, --reset                Reset the environment and login with full configuration flow
  -t, --tenantscope          Set tenant scope
  -i, --viewer               Set viewer role
warning

Ensure you have already signed up for an account on the Atym Hub before attempting to login.

logout​

Logs the user out from the Atym Hub.

Usage:
  atym logout

Flags:
  -h, --help   help for logout