How-to guides

How do I create a client key?

Clients are used to authenticate with the CipherStash API. We will use a client key to authenticate with the CipherStash API when we deploy Tandem. To create a client, you will need to have created a dataset first.

Creating a client

When you create a client you will need to provide a name and a dataset ID. The dataset ID is the ID of the dataset you want to associate this client with. A client belongs to a single dataset, but a dataset can have multiple clients.

You will need the CipherStash CLI installed to create a client. If you don't have the CLI installed, please follow the installation guide.

1stash clients create --dataset-id $CS_DATASET_ID "Tandem example application"
2

The output will look like this:

1Client created:
2Client ID  : <a UUID style ID>
3Name       : Tandem example application
4Description:
5Dataset ID : <your provided dataset ID>
6
7#################################################
8#                                               #
9#  Copy and store these credentials securely.   #
10#                                               #
11#  THIS IS THE LAST TIME YOU WILL SEE THE KEY.  #
12#                                               #
13#################################################
14
15Client ID          : <a UUID style ID>
16
17Client Key [hex]   : <a long hex string>
18

Note down the client key somewhere safe, like a password vault. You will not be able to see the client key again. You can also set local environment variables to make it easier to use the key info in the next steps:

1export CS_CLIENT_ID=<your client ID>
2export CS_CLIENT_KEY=<your client key>
3

Asking for help

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

Previous
Creating datasets