Tue, 16 Apr, 2024

Authentication

CLI Authentication in 01Cloud

Overview:

auth command helps you for authentication process, to the 01cloud eco-system. There are few sub-commands on this command, which generally works as below,

First, the input is obtained either from the operating system’s standard input or from environment variables. Then, the zocli communicates with the 01Cloud server to authenticate the user. The server logs this login session, allowing users to review their session details through the web UI.

To access the help menu for this command, you can begin by executing the following:

zocli auth --help

Login:

This command allows you to log in to the 01Cloud ecosystem, enabling you to perform various tasks. There are multiple options available for logging in using zocli.

Single Sign On (SSO):

The recommended method for logging into the system is by using this option. This ensures that your credentials remain secure and cannot be compromised while allowing you to log in with ease.

To log in to the system using SSO, follow the steps below:

Getting Started:

Start by authenticating with either of the following commands:

zocli auth login [-s || --sso]

zocli auth login

Choose the SSO: Login with browser using 01Cloud SSO (Single Sign On) Token option (which is printed on the console) to proceed on.

NOTE: To move along the options you can use your UP / DOWN keys on keyboard to proceed on, and even can filter the options typing typing characters.

CLI generated Token:

After choosing the option, the zocli communicates with the server and gets a new SSO token from the server as response, which can be used within 5 minutes to login. The zocli might have now printed the SSO token on the console like below,

Login in using the browser using a dynamically generated code.
! First copy your one-time code: 111111
Press Enter to open https://console.01cloud.io/login/sso in your browser...

Login through browser:

  • Now either click on the link to open your default browser, or copy the link and paste to any browser, or press ENTER so the cli can open your default browser for you.

  • Then after you login to your 01cloud account (If not already logged in), you will be sent the link which was printed on the terminal.

  • You can enter the CODE (printed on the console) on the text box and Press on Continue, and that will now log you to the ZOCLI. You might should wait for couple of seconds, so that the zocli fetches all your token credentails to log you in.

  • The maximum time for fetching the status will be at around 5 seconds, as the CLI continuosly fetches the status of the code in every 5 seconds. You can verify the login using the ZOCLI auth status command.

Aceess Token:

To log in using an Access Token, follow the steps below. (You may skip the following step if you have already generated a token from the profile section of the UI)

Generate Access Token:

  • An Access Token can be generated from the profile section of the 01Cloud web portal or console. To generate a token, navigate to PROFILE > ACCESS TOKEN.

  • Click on New Token, and you will be prompted to enter a Note and set the expiration time for the token. Fill in the details as required.

  • After clicking Generate, the web UI will display the newly created token. Ensure you copy the token, as it will only be visible once.

Input Token in CLI:

Now, execute the zocli login sub-command with the -t flag enabled, as shown below:

zocli auth login [-t || --token]

or use

zocli auth login

Select Token: Login using pre-created token to proceed. The zocli will then prompt you to enter the token. Paste the token generated in the previous step.

The zocli will communicate with the server to validate the token and authenticate your login. If the authentication is successful, a confirmation message will be displayed on the console.

✓ Logged in successfully as yourmail@mail.com

Export to Environment:

You can also log in to the system by exporting a variable containing the token as its value. For example:

export CLI_WEBTOKEN=token

This will export your token to the operating system’s environment variables for the current shell session. You can then log in directly using zocli with the following command:

zocli auth login [-t || --token]

Basic Creds:

This option enables you to log in using your basic username and password. To begin, use the following command:

zocli auth login [-b || --basic]

The zocli will then prompt you to enter your username and password via the standard console. Once the credentials are validated by the server, you will be logged in, and the following message will be displayed on the console:

✓ Logged in successfully as yourmail@mail.com

Not a Recommended Login Method

Note: This login method is not recommended and may be removed in future releases.

You can export the CLI_EMAIL and CLI_PASSWORD environment variables in the active shell session and then use the following command:

zocli auth login [- || --basic]

This method allows automatic login to the ecosystem, as the CLI checks for specific environment variables during system initialization. You can refer to the available environment variables here.

Summary:

  • Use zocli auth login -b or –basic to authenticate with email and password.
  • Use zocli auth login -s or –sso to authenticate using the Single Sign-On method via the browser.
  • Use zocli auth login -t or –token to log in using an access token.
  • Use zocli auth login to view all available login options.

You can always access the help menu by using the following command:

zocli auth login --help

Logout:

The command removes the authentication configuration from the device and, by default, invalidates the session for the token.

zocli auth logout

If you wish to log out without invalidating the session on the server, use the -d flag as shown below:

zocli auth logout -d

This will remove the authentication configuration from the device only.

Upon successful logout, zocli will display the following message on the console:

✓ Successfully Logged out.

Status:

The following command allows you to verify whether your token is valid:

zocli auth status

If the token is valid, the command will display your profile details along with quota information, as shown below:

✓ Token is valid
✓ Fetched Profile

PROFILE
Name : yourName
Email : yourEmail@mail.com
Company : yourCompanyName

QUOTAS
Projects : totalNoOfProjects
Organizations : totalOrganizations

CLI

Project