> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# fortanix/sdkms-cli

Install and configure Fortanix SDKMS CLI tool View this orb's source at - https://github.com/fortanix/sdkms-cli-orb


## Commands

### authenticate

Authenticate to SDKMS

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api-endpoint` | string | https://sdkms.fortanix.com | SDKMS API Endpoint |
| `api-key` | string |  | SDKMS API Key |

### get-secret

Get a secret value from SDKMS

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api-endpoint` | string | https://sdkms.fortanix.com | SDKMS API Endpoint |
| `secret-file` | string |  | "If secret value being retrieved is huge, use this parameter to specify \"
\" the file to store the secret value"
 |
| `secret-name` | string |  | Name of secret to retrieve. |

### install

Install the SDKMS CLI via pip

### logout

Terminate authentication session with SDKMS

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api-endpoint` | string | https://sdkms.fortanix.com | SDKMS API Endpoint |

### store-secret

Store a secret in SDKMS

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api-endpoint` | string | https://sdkms.fortanix.com | SDKMS API Endpoint |
| `secret-description` | string |  | Description of secret |
| `secret-file` | string |  | "If secret value to be stored is huge, use this parameter to specify \"
\" the file that contains the secret value"
 |
| `secret-name` | string |  | Name of secret." " This will be used to retrieve secret value later |
| `secret-value` | string |  | "Secret value to store in SDKMS. This value can be plain text value."\
\" If the value is a binary data, then value should be passed as\"
\" base64 encoded"
 |

## Jobs

### get-secret-value

Install SDKMS CLI if needed, authenticate and get a secret value from SDKMS


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api-endpoint` | string | https://sdkms.fortanix.com | SDKMS API Endpoint |
| `api-key` | string |  | SDKMS API Key |
| `secret-file` | string |  | "If secret value being retrieved is huge, use this parameter to specify \"
\" the file to store the secret value"
 |
| `secret-name` | string |  | Name of secret to retrieve. |

### store-secret-value

Install SDKMS CLI if needed, authenticate and store a secret value in SDKMS


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api-endpoint` | string | https://sdkms.fortanix.com | SDKMS API Endpoint |
| `api-key` | string |  | SDKMS API Key |
| `secret-description` | string |  | Description of secret |
| `secret-file` | string |  | "If secret value to be stored is huge, use this parameter to specify \"
\" the file that contains the secret value"
 |
| `secret-name` | string |  | Name of secret to retrieve. |
| `secret-value` | string |  | "Secret value to store in SDKMS. This value can be plain text value."\
\" If the value is a binary data, then value should be passed as\"
\" base64 encoded"
 |

## Executors

### default

The Debian-based Docker container to use when installing SDKMS CLI

| Parameter | Type | Default | Description |
|---|---|---|---|
| `python-version` | string | 2.7 |  |
| `release` | string | stretch |  |

## Examples

### example

# What will this example document? # Descriptions should be short, simple, and clear.


```yaml
jobs:
  sdkms-cli:
    executor: sdkms-cli/default
    steps:
      - checkout
      - sdkms-cli/install
orbs:
  sdkms-cli: ffaruqui_sandbox/sdkms-cli@0.0.1
version: 2.1
```