Generating API Keys

Overview

OpenLegacy uses three types of API Keys for authentication:

• User API Keys are used for user authentication (CLI, Generated Services).
• Account API Keys are used for automation/ci/deployment to OL Runtime (authentication between the Runtime and the OL Hub). An Account API Key is used by an Admin or by the system.
• Runtime API Keys are used for OL Runtime API Gateway authentication. A Runtime API Key is used by an OL Runtime/Partner user.

The OpenLegacy CLI asks for your API key as part of your login authentication process. After you log in, the CLI stores the key in its configuration file and uses it to encrypt and decrypt the communication between the CLI and the OL Hub.

To generate an API key:

1.  Sign up and log in to the OL Hub.

2. In the OL Hub, click your user avatar on the right side of the top bar and select API Keys. 
   

3. In the API Keys tab, click GENERATE API KEY .

4. Type the Key name  and click Generate.

5. Click COPY To Clipboard.

6. Before clicking Done, copy and paste the new API key to a secure location for future use.

When you click Done, the key becomes hidden.

The new API key appears in the list of API keys.

❗️

If you revoke the key by clicking Revoke, any communication secured by this key will not be decrypted.

Now you can log in to the OL Hub from the CLI tool with the API key you have just generated.