Access key guide

Access keys are used to authenticate with the CipherStash API. You'll use an access key to authenticate with the CipherStash API when you deploy CipherStash Proxy. This enables you to deploy CipherStash Proxy as a machine user.

Creating an access key

You can create an access key using the Dashboard or using CipherStash CLI.

Using the Dashboard

1. Log in to the CipherStash Dashboard.

2. Click Manage Workspace next to the workspace you want to create an access key for.

3. Click Settings in the navigation bar.

4. Click Create Key in the Access Keys section.

5. Type a name for the access key and click Create key.

The maximum length of an access key name is 42 characters.

Using CipherStash CLI

When you create an access key you'll need to provide a name and a workspace ID. The workspace ID is the ID of the workspace you want to associate this access key with. An access key belongs to a single workspace, but a workspace can have multiple access keys.

If you don't have the CLI installed, follow the instructions for installing the CipherStash CLI.

1stash access-keys create --workspace-id $CS_WORKSPACE_ID cipherstash-proxy-tutorial

This will generate an access key and display the access key for programmatic access. Make sure you copy the access key and save it for deployment.

Login if required

If you're unable to modify the provider or encounter an authentication error (403 Forbidden), you may need to login:

1stash login

Login opens your browser - follow the prompts to authenticate.

Deleting an access key

Delete an access key using the Dashboard or using CipherStash CLI.

Note that deleting an access key will result in any machine using that key losing access to CipherStash.

Using the Dashboard

1. Log in to the CipherStash Dashboard.

2. Click on Manage Workspace next to the workspace you want to create an access key for.

3. In the navigation bar click on Settings.

4. In the Access Keys section click the delete icon next to the access key.

5. Click the green tick to confirm deletion.

Using CipherStash CLI

To delete an access key, you'll need to provide the name of the key and the workspace ID. The workspace ID is the ID of the workspace the access key is associated to.

You can list all access keys for the workspace you are currently logged in to by running:

1stash access-keys

To delete an access key:

1stash access-keys revoke --workspace-id $CS_WORKSPACE_ID cipherstash-proxy-tutorial

Using an access key with CipherStash Proxy

CipherStash Proxy uses an access key as a machine-to-machine authentication method with CipherStash Cloud to pull down a dataset configuration. CipherStash Proxy will ingest the access key as an environment variable. The access key is only one of the environment variables that CipherStash Proxy needs to authenticate with CipherStash Cloud.

Getting help

We highly recommend setting up a call with one of our Solutions Engineers to help you get started. We're happy to help!