This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Secret Vault

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Secret Vault and how to call CLI. The output is formatted as a JSON string

Version

VersionStatusSupported Until
1.0CURRENT-

1 - CLIs

1.1 - Create Secret Vault

1.1.1 - 1.0

scpcli secretvault sv create
--vault_token_ttl_ndays <value>
--temporary_key_ttl_nhours <value>
--name <value>
--acl_cidr <value>
--access_key_id <value>
[--description <value>]
[--tags <value>]

Description

Create Secret Vault.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
vault_token_ttl_ndays
required
integerTTL of vault token720
temporary_key_ttl_nhours
required
integerTemporary key valid hours3
name
required
stringSecret Vault Idname
acl_cidr
required
stringAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
access_key_id
required
stringId of access keyb754b12b39da4ce29a40c5e324650bd0
description
optional
stringDescriptiondescription
tags
optional
arrayTag List''{"key": "", "value": ""}'

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access keyTemporary
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescriptiondescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keyvaultkey
temporary_key_ttl_nhoursTemporary key valid hours36
user_nameUser nameusername
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault tokenaace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_valueSecret of vault token6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndaysTTL of vault token10
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault keySCP Open API Key
waiting_time_ndaysDays remaining until deletion10

1.2 - Delete Secret Vault

1.2.1 - 1.0

scpcli secretvault sv delete
--secret_vault_id <value>
--waiting_time_ndays <value>

Description

Change Secret Vault state to ‘To be terminated’.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_vault_id
required
stringSecret Vault Id3265ab469f0d406d83073da3e11e7a6c
waiting_time_ndays
required
integerDays remaining until deletion7

1.3 - List Secret Vaults

1.3.1 - 1.0

scpcli secretvault sv list

Description

List Secret Vaults.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access keyTemporary
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescriptiondescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of keyvaultkey
temporary_key_ttl_nhoursTemporary key valid hours36
user_nameUser nameusername
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault token[AES] SZtB6RasvLypCv4soJlQO3ZmYpUPjFblz7pstjBeTQJXcz/d5KB9TUR3gMY08mga4fxWaF6IfUzTMBh6j/CAaw==
vault_token_secret_valueSecret of vault token[AES] 91/kdnK4NDfs2HGWgNH/EYNnqD7OcM1unXWs0ZAuaFttIqgP8xMUx0dOaRfD6kOD7uuujFxF2nzx35D9Gz9nwQ==
vault_token_ttl_ndaysTTL of vault token10
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault keySCP Open API Key
waiting_time_ndaysDays remaining until deletion10

1.4 - Show Secret Vault

1.4.1 - 1.0

scpcli secretvault sv show
--secret_vault_id <value>

Description

Show Secret Vault.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

NameTypeDescriptionExample
secret_vault_id
required
stringSecret Vault Id3265ab469f0d406d83073da3e11e7a6c

Responses

NameDescriptionExample
idID0fdd87aab8cb46f59b7c1f81ed03fb3e
access_keyAccess key[‘0e3*****************************’]
access_key_idId of access key0e3dffc50eb247a1adf4f2e5c82c4f99
access_key_typeType of access key[‘Temporary’, ‘Permanent’]
account_idAccount ID3265ab469f0d406d83073da3e11e7a6c
acl_cidrAccess control list in CIDR192.168.1.1/24, 10.0.0.1/16
created_atCreated At2024-05-17T00:23:17Z
created_byCreated By90dddfc2b1e04edba54ba2b41539a9ac
delete_atDate of deletion2025-02-25 03:07:17.000
descriptionDescription of Keydescription
modified_atModified At2024-05-17T00:23:17Z
modified_byModified By90dddfc2b1e04edba54ba2b41539a9ac
nameName of key[‘vaultkey’]
temp_key_expired_atTemporary key expired date2025-02-25 03:07:17.000
temporary_key_ttl_nhoursTemporary key valid hours[‘36’]
vault_token_expired_atVault Token expired date2025-02-25 03:07:17.000
vault_token_idId of vault tokenaace85da-965e-d95a-b4ed-8d32b5d6079
vault_token_secret_valueSecret of vault token6171392c-5fd9-43db-9e15-e14af0068f96
vault_token_ttl_ndaysTTL of vault token[‘10’]
vaultkey_stateState of key(Creating, Active, Error, Stop, To_Be_Terminated)Active
vaultkey_typeType of vault key[‘SCP Open API Key’]
waiting_time_ndaysDays remaining until deletion10