Creación de un Secreto
Función
Esta API se utiliza para crear un secreto y almacenar el valor secreto en la versión secreta inicial.
Los valores secretos se cifran y se almacenan en versiones secretas. Una versión puede tener varios estados. Las versiones sin ningún estado se consideran versiones obsoletas y pueden ser eliminadas automáticamente por CSMS.
La versión inicial se marca con la etiqueta de estado SYSCURRENT.
Restricciones
Puede utilizar una customer master key (CMK) simétrica (CMK) para cifrar un secreto. Si no se especifica el parámetro kms_key_id, se utilizará la clave maestra predeterminada csms/default para cifrar secretos. La clave predeterminada es creada automáticamente por CSMS.
Para usar una clave definida por el usuario para cifrar secretos, necesita tener el permiso kms:dek:create para la clave.
URI
POST /v1/{project_id}/secrets
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto |
Parámetro de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API IAM (valor de X-Subject-Token en el encabezado de respuesta). |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
name |
Sí |
String |
Nombre de secreto. Restricción: El valor puede contener de 1 a 64 caracteres y debe coincidir con la expresión regular ^[a-zA-Z0-9._-]{1,64}$. |
kms_key_id |
No |
String |
ID del CMK KMS utilizado para cifrar secretos. Si no se especifica este parámetro, se usará la clave maestra predeterminada csms/default. La clave predeterminada es creada automáticamente por CSMS. |
description |
No |
String |
Descripción de un secreto. Restricciones: el valor contiene 2048 bytes. |
secret_binary |
No |
String |
Texto sin formato de un secreto binario en formato Base64. CSMS lo encripta y lo almacena en la versión inicial del secreto. Tipo: objeto de datos binarios en formato Base64 Restricciones: Debe configurar uno y solo uno de secret_binary y secret_string. El tamaño máximo es de 32 KB. |
secret_string |
No |
String |
Texto sin formato de un secreto binario en formato de texto. CSMS lo encripta y lo almacena en la versión inicial del secreto. Restricciones: Debe configurar uno y solo uno de secret_binary y secret_string. El tamaño máximo es de 32 KB. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
secret |
Secret object |
Secreto |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de secreto |
name |
String |
Nombre de secreto |
state |
String |
Estado de secreto. Su valor puede ser: ENABLED DISABLED PENDING_DELETE FROZEN |
kms_key_id |
String |
ID del KMS CMK utilizado para cifrar valores secretos |
description |
String |
Descripción de un secreto |
create_time |
Long |
Tiempo de creación de secreto. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). |
update_time |
Long |
Hora en la que un secreto fue actualizado por última vez. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). |
scheduled_delete_time |
Long |
Hora en la que se eliminará un secreto según lo programado. La marca de tiempo indica el total de segundos después del inicio de la fecha de época (1 de enero de 1970). Si un secreto no está en estado de Pending deletion, el valor de este parámetro es null. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error |
error_msg |
String |
Descripción del error |
Solicitud de ejemplo
{ "name" : "demo", "kms_key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "secret_string" : "this is a demo secret string" }
Ejemplo de respuesta
Código de estado: 200
La solicitud se ha realizado correctamente.
{ "secret" : { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "name" : "test", "state" : "ENABLED", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "description" : "description", "create_time" : 1581507580000, "update_time" : 1581507580000, "scheduled_delete_time" : 1581507580000 } }
Código de estado
Código de estado |
Descripción |
---|---|
200 |
La solicitud se ha realizado correctamente. |
400 |
Parámetros de solicitud no válidos. |
Códigos de error
Consulte Códigos de error.