2.3. Authenticating by using the roxctl CLI

Procedure

1. In the RHACS portal, go to Platform Configuration Integrations.
2. Scroll to the Authentication Tokens category, and then click API Token.
3. Click Generate Token.
4. Enter a name for the token and select a role that provides the required level of access (for example, Continuous Integration or Sensor Creator).

5. Click Generate.

   중요

   Copy the generated token and securely store it. You will not be able to view it again.

Procedure

1. After you have generated the authentication token, export it as the ROX_API_TOKEN variable by entering the following command:

   $ export ROX_API_TOKEN=<api_token>

2. (Optional): You can also save the token in a file and use it with the --token-file option by entering the following command:

   $ roxctl central debug dump --token-file <token_file>

   Note the following guidelines:

   • You cannot use both the -password (-p) and the --token-file options simultaneously.
   • If you have already set the ROX_API_TOKEN variable, and specify the --token-file option, the roxctl CLI uses the specified token file for authentication.
   • If you have already set the ROX_API_TOKEN variable, and specify the --password option, the roxctl CLI uses the specified password for authentication.

Procedure

1. Run the following command to set the ROX_ENDPOINT variable to Central hostname and port:

   export ROX_ENDPOINT=<central_hostname:port>

2. Run the following command to initiate the login process to Central:

   $ roxctl central login

3. Within the roxctl CLI, a URL is printed as output and you are redirected to a browser window where you can select the authentication provider you want to use.

4. Log in with your authentication provider.

   After you have successfully logged in, the browser window indicates that authentication was successful and you can close the browser window.

5. The roxctl CLI displays your token information including details such as the access token, the expiration time of the access token, the refresh token if one has been issued, and notification that these values are stored locally.

   Example output

   Please complete the authorization flow in the browser with an auth provider of your choice.
   If no browser window opens, please click on the following URL:
           http://127.0.0.1:xxxxx/login
   INFO:	Received the following after the authorization flow from Central:
   INFO:	Access token: <redacted>
   INFO:	Access token expiration: 2023-04-19 13:58:43 +0000 UTC
   INFO:	Refresh token: <redacted>
   INFO:	Storing these values under $HOME/.roxctl/login…

   • Access token: <redacted> is the access token.
   • Access token expiration: 2023-04-19 13:58:43 +0000 UTC is the expiration time of the access token.
   • Refresh token: <redacted> is the refresh token.

   • $HOME/.roxctl/login… is the directory where values of the access token, the access token expiration time, and the refresh token are stored locally.

     중요

     Ensure that you set the environment to determine the directory where the configuration is stored. By default, the configuration is stored in the $HOME/.roxctl/roxctl-config directory.

     • If you set the $ROX_CONFIG_DIR environment variable, the configuration is stored in the $ROX_CONFIG_DIR/roxctl-config directory. This option has the highest priority.
     • If you set the $XDG_RUNTIME_DIR environment variable and the $ROX_CONFIG_DIR variable is not set, the configuration is stored in the $XDG_RUNTIME_DIR /roxctl-config directory.
     • If you do not set the $ROX_CONFIG_DIR or $XDG_RUNTIME_DIR environment variable, the configuration is stored in the $HOME/.roxctl/roxctl-config directory.