CLI de Secrets Manager
Puede utilizar la interfaz de línea de mandatos (CLI) de IBM Cloud® Secrets Manager para gestionar secretos en la instancia de Secrets Manager.
Versión actual: 2.0.16
Requisitos previos
Instale IBM Cloud CLI y, a continuación, el complemento Secrets Manager CLI ejecutando el siguiente comando :
ibmcloud plugin install secrets-manager
Se le notifica en la línea de mandatos cuando las actualizaciones de la CLI de IBM Cloud y los plug-ins están disponibles. Asegúrese de que mantiene actualizada la CLI para poder utilizar los mandatos más recientes. Puede ver la versión actual
de todos los plugins instalados con el mandato ibmcloud plugin list.
Dirigirse a una instancia de Secrets Manager
Para establecer como destino la instancia de Secrets Manager, utilice una de las opciones siguientes.
-
Ejecute el mandato
ibmcloud secrets-manager config set.ibmcloud secrets-manager config set service-url https://{instance_ID}.{region}.secrets-manager.appdomain.cloud -
Exporte una variable de entorno con el URL de punto final de servicio de Secrets Manager.
export SECRETS_MANAGER_URL=https://{instance_ID}.{region}.secrets-manager.appdomain.cloud -
Establezca el punto final de servicio en el mandato.
ibmcloud secrets-manager secrets --service-url https://{instance_ID}.{region}.secrets-manager.appdomain.cloud
Sustituya {instance_ID} y {region} por los valores que se aplican a la instancia de servicio de Secrets Manager. Para encontrar el URL de punto final específico de la instancia, puede copiarlo de la página Puntos finales en la interfaz de usuario de Secrets Manager. Para obtener más información, consulte Visualización de URL de punto final
Valores globales
Mandatos
ibmcloud secrets-manager docs
Abre la documentación del plug-in en el navegador web.
ibmcloud secrets-manager docs
Ejemplo
ibmcloud secrets-manager docs
Opciones
--instance-id(cadena)- El ID de instancia de Secrets Manager asignado por el proveedor de servicios.
--region(cadena)- La región donde ha suministrado la instancia de Secrets Manager. Valores disponibles: us-south, us-east, au-syd, jp-osa, jp-tok, eu-de, eu-gb, eu-es, ca-tor, ca-mon, br-sao.
--output(cadena)- Elija un formato de salida; puede ser 'json', 'yaml' o 'table'. El valor predeterminado es 'table'.
-j,--jmes-query(serie)- Proporcione una consulta JMESPath para personalizar la salida.
--service-url(cadena)- Proporcione el URL de punto final base para la API.
-q,--quiet- Suprime los mensajes detallados.
-v,--version- Imprime la versión del plug-in.
Ejemplo
ibmcloud secrets-manager
--instance-id=provide-here-your-smgr-instanceuuid \
--region=us-south \
--output=json \
--jmes-query="[:10]" \
--service-url="https://myservice.cloud.ibm.com"
--quiet
Este ejemplo sólo muestra las opciones globales disponibles para todos los comandos y no es un comando válido en sí mismo.
Config
Los parámetros globales también pueden almacenarse en una configuración persistente para que no sea necesario especificarlos manualmente cada vez que se invoque el complemento. Cada parámetro se puede configurar con el mandato config y sus submandatos.
ibmcloud secrets-manager config
ibmcloud secrets-manager config set
Establezca un nuevo valor de configuración para una opción específica. Cada submandato del mandato set se correlaciona con una opción global. Cada submandato acepta un único argumento, la representación de serie del valor que
se va a almacenar para la opción.
ibmcloud secrets-manager config set <option> <value>
Ejemplos
ibmcloud secrets-manager config set service-url \
'https://{instance_id}.{region}.secrets-manager.appdomain.cloud'
ibmcloud secrets-manager config get
Imprime el valor ajustado actualmente para una opción específica. Cada submandato del mandato get se correlaciona con una opción global.
ibmcloud secrets-manager config get <option>
Ejemplos
ibmcloud secrets-manager config get service-url
ibmcloud secrets-manager config unset
Desestablezca el valor establecido actualmente para una opción específica. Cada submandato del mandato unset se correlaciona con una opción global.
Los submandatos disponibles para este servicio son: service-url,.
ibmcloud secrets-manager config unset <option>
Ejemplos
ibmcloud secrets-manager config unset service-url
ibmcloud secrets-manager config list
Lista todos los valores de configuración establecidos actualmente.
ibmcloud secrets-manager config list
Ejemplos
ibmcloud secrets-manager config list
Grupos de secretos
Controlar quién puede acceder a los secretos creando y gestionando grupos.
ibmcloud secrets-manager secret-group-create
Crea un grupo secreto que podrás utilizar para organizar los secretos y controlar quién puede acceder a ellos.
Una solicitud correcta devuelve el valor ID del grupo secreto, junto con otras propiedades. Para obtener más información sobre los grupos de secretos, consulte docs.
ibmcloud secrets-manager secret-group-create --name NAME [--description DESCRIPTION]
Opciones de comando
--name(cadena)-
El nombre del grupo de secretos. Obligatorio.
La longitud máxima es de
64caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/. --description(cadena)-
Una descripción ampliada del grupo de secretos.
La longitud máxima es de
1024caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/.
Ejemplo
ibmcloud secrets-manager secret-group-create \
--name my-secret-group \
--description 'Extended description for this group.'
Salida de ejemplo
Ejemplo de respuesta SecretGroup
{
"created_at" : "2020-10-05T21:33:11Z",
"description" : "Extended description for this group.",
"id" : "d898bb90-82f6-4d61-b5cc-b079b66cfa76",
"name" : "my-secret-group",
"updated_at" : "2020-11-25T22:13:10Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
}
ibmcloud secrets-manager secret-groups
Liste los grupos de secretos que están disponibles en la instancia de Secrets Manager.
ibmcloud secrets-manager secret-groups
Ejemplo
ibmcloud secrets-manager secret-groups
Salida de ejemplo
Ejemplo de respuesta de colección de SecretGroup
{
"secret_groups" : [ {
"created_at" : "2020-09-05T21:33:11Z",
"description" : "Default Secret Group",
"id" : "ee52ebb6-1728-4580-8ede-13f6504e3ae0",
"name" : "default",
"updated_at" : "2020-09-25T22:13:10Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
}, {
"created_at" : "2020-10-05T21:33:11Z",
"description" : "Extended description for this group.",
"id" : "cb52ebb6-1728-4580-8ede-13f6504e3ae0",
"name" : "my-secret-group",
"updated_at" : "2020-11-25T22:13:10Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
}, {
"created_at" : "2020-10-05T22:05:15Z",
"description" : "Extended description for this group.",
"id" : "19f88b9c-4f2f-405c-b877-a09338575c3f",
"name" : "my-second-secret-group",
"updated_at" : "2020-11-25T22:13:10Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
} ],
"total_count" : 3
}
Predeterminado JMESPath
Se aplicará una consulta JMESPath a la salida de este comando de forma predeterminada, si el usuario no proporciona una. La consulta exacta dependerá del escenario y del formato de salida solicitado. Puede ver la condición de cada consulta predeterminada de JMESPath en la siguiente tabla:
| Respuesta | Salida | Consulta |
|---|---|---|
| Correcto | Valor predeterminado |
|
| Tabla | secret_groups[*] |
|
| Error | Valor predeterminado |
|
| Tabla | secret_groups[*] |
|
| Todas las páginas | Valor predeterminado |
|
| Tabla | secret_groups[*] |
Si se proporciona una consulta personalizada de JMESPath, sustituirá a cualquiera de las JMESPath de la tabla anterior.
ibmcloud secrets-manager secret-group
Obtener las propiedades de un grupo secreto existente especificando el ID del grupo.
ibmcloud secrets-manager secret-group --secret-group-id SECRET-GROUP-ID
Opciones de comando
--secret-group-id(cadena)-
El ID del grupo de secretos. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
Ejemplo
ibmcloud secrets-manager secret-group \
--secret-group-id d898bb90-82f6-4d61-b5cc-b079b66cfa76
Salida de ejemplo
Ejemplo de respuesta SecretGroup
{
"created_at" : "2020-10-05T21:33:11Z",
"description" : "Extended description for this group.",
"id" : "d898bb90-82f6-4d61-b5cc-b079b66cfa76",
"name" : "my-secret-group",
"updated_at" : "2020-11-25T22:13:10Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
}
ibmcloud secrets-manager secret-group-update
Actualiza las propiedades de un grupo secreto existente, como su nombre o descripción.
ibmcloud secrets-manager secret-group-update --id ID [--name NAME] [--description DESCRIPTION]
Opciones de comando
--id(cadena)-
El ID del grupo de secretos. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --secret-group-patch(correlación genérica)-
El cuerpo de solicitud para actualizar un grupo de secretos. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-group-patch=@path/to/file.json. --name(cadena)-
El nombre del grupo de secretos. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-group-patch". Es mutuamente excluyente con esa opción.
La longitud máxima es de
64caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/. --description(cadena)-
Una descripción ampliada del grupo de secretos. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-group-patch". Es mutuamente excluyente con esa opción.
La longitud máxima es de
1024caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/.
Ejemplo
ibmcloud secrets-manager secret-group-update \
--id d898bb90-82f6-4d61-b5cc-b079b66cfa76 \
--name my-secret-group \
--description 'Extended description for this group.'
Salida de ejemplo
Ejemplo de respuesta SecretGroup
{
"created_at" : "2020-10-05T21:33:11Z",
"description" : "Extended description for this group.",
"id" : "d898bb90-82f6-4d61-b5cc-b079b66cfa76",
"name" : "my-secret-group",
"updated_at" : "2020-11-25T22:13:10Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21"
}
ibmcloud secrets-manager secret-group-delete
Suprima un grupo de secretos especificando el ID del grupo de secretos.
Nota: Para suprimir un grupo de secretos, debe estar vacío. Si necesitas eliminar un grupo secreto que contiene secretos, primero debes eliminar los secretos asociados al grupo.
ibmcloud secrets-manager secret-group-delete --id ID
Opciones de comando
--id(cadena)-
El ID del grupo de secretos. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
Ejemplo
ibmcloud secrets-manager secret-group-delete \
--id d898bb90-82f6-4d61-b5cc-b079b66cfa76
Secretos
Cree, ordene y gestione distintos tipos de secretos para sus aplicaciones y servicios.
ibmcloud secrets-manager secret-create
Cree un secreto o importe un valor existente que pueda utilizar para acceder o autenticarse en un recurso protegido.
Utilice esta operación para generar o importar un secreto existente, como un certificado TLS, que puede gestionar en su instancia de servicio Secrets Manager. Una solicitud correcta almacena el secreto en su instancia dedicada, basándose en el tipo de secreto y los datos que especifique. La respuesta devuelve el valor de ID del secreto, junto con otros metadatos.
Para obtener más información sobre los tipos de secretos que puede crear con Secrets Manager, consulte docs.
ibmcloud secrets-manager secret-create [--secret-prototype SECRET-PROTOTYPE | --secret-custom-metadata SECRET-CUSTOM-METADATA --secret-description SECRET-DESCRIPTION --secret-expiration-date SECRET-EXPIRATION-DATE --secret-labels SECRET-LABELS --secret-name SECRET-NAME --secret-group-id SECRET-GROUP-ID --secret-type SECRET-TYPE --arbitrary-payload ARBITRARY-PAYLOAD --secret-version-custom-metadata SECRET-VERSION-CUSTOM-METADATA --secret-ttl SECRET-TTL --iam-credentials-access-groups IAM-CREDENTIALS-ACCESS-GROUPS --iam-credentials-service-id IAM-CREDENTIALS-SERVICE-ID --iam-credentials-account-id IAM-CREDENTIALS-ACCOUNT-ID --iam-credentials-reuse-apikey=IAM-CREDENTIALS-REUSE-APIKEY --secret-rotation SECRET-ROTATION --imported-cert-certificate IMPORTED-CERT-CERTIFICATE --imported-cert-intermediate IMPORTED-CERT-INTERMEDIATE --imported-cert-private-key IMPORTED-CERT-PRIVATE-KEY --imported-cert-managed-csr IMPORTED-CERT-MANAGED-CSR --kv-data KV-DATA --private-cert-template-name PRIVATE-CERT-TEMPLATE-NAME --certificate-common-name CERTIFICATE-COMMON-NAME --certificate-alt-names CERTIFICATE-ALT-NAMES --private-cert-ip-sans PRIVATE-CERT-IP-SANS --private-cert-uri-sans PRIVATE-CERT-URI-SANS --private-cert-other-sans PRIVATE-CERT-OTHER-SANS --private-cert-csr PRIVATE-CERT-CSR --private-cert-format PRIVATE-CERT-FORMAT --private-cert-private-key-format PRIVATE-CERT-PRIVATE-KEY-FORMAT --private-cert-exclude-cn-from-sans=PRIVATE-CERT-EXCLUDE-CN-FROM-SANS --public-cert-key-algorithm PUBLIC-CERT-KEY-ALGORITHM --public-cert-ca PUBLIC-CERT-CA --public-cert-dns PUBLIC-CERT-DNS --public-cert-bundle-ca=PUBLIC-CERT-BUNDLE-CA --secret-source-service SECRET-SOURCE-SERVICE --username-password-username USERNAME-PASSWORD-USERNAME --username-password-password USERNAME-PASSWORD-PASSWORD --username-password-policy USERNAME-PASSWORD-POLICY --custom-credentials-configuration CUSTOM-CREDENTIALS-CONFIGURATION --custom-credentials-parameters CUSTOM-CREDENTIALS-PARAMETERS]
Opciones de comando
--secret-prototype(SecretPrototype)-
Un archivo JSON que contiene los detalles necesarios para crear un secreto. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-prototype=@path/to/file.json. --secret-custom-metadata(correlación genérica)-
Los metadatos secretos que un usuario puede personalizar. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-custom-metadata=@path/to/file.json. --secret-description(cadena)-
Una descripción ampliada de su secreto. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
1024caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --secret-expiration-date(strfmt.DateTime)-
La fecha en que caduca el material secreto. El formato de la fecha sigue el formato
RFC 3339. Tipos de secreto soportados: arbitrary, username_password. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción. --secret-labels(serie[])-
Etiquetas que puede utilizar para buscar secretos en la instancia. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de30elementos. La longitud mínima es de0artículos. --secret-name(cadena)-
Un nombre legible por personas que asignar al secreto. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
256caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/. --secret-group-id(cadena)-
Un identificador UUID, o grupo secreto
default. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/. --secret-type(cadena)-
El tipo de secreto. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
arbitrary,iam_credentials,imported_cert,kv,private_cert,public_cert,service_credentials,username_password,custom_credentials. --arbitrary-payload(cadena)-
Los datos secretos que se asignan a un secreto
arbitrary. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
1000000caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --secret-version-custom-metadata(correlación genérica)-
Los metadatos de la versión de secreto que un usuario puede personalizar. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-version-custom-metadata=@path/to/file.json. --secret-ttl(cadena)-
Tiempo de vida (TTL) o duración del arrendamiento que asignar a las credenciales que se generan. Tipos de secreto admitidos: iam_credentials, service_credentials, custom_credentials. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --iam-credentials-access-groups(serie[])-
Grupos de acceso que puede utilizar para un secreto
iam_credentials. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.Los elementos de lista deben coincidir con la expresión regular
/^AccessGroupId-[a-z0-9-]+[a-z0-9]$/. La longitud máxima es de10elementos. La longitud mínima es1item. --iam-credentials-service-id(cadena)-
ID de servicio bajo el que se crea la clave de API. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud debe ser de
46caracteres. El valor debe coincidir con la expresión regular/^ServiceId-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/. --iam-credentials-account-id(cadena)-
El ID de la cuenta en la que se crean las credenciales de IAM. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud debe ser de
32caracteres. El valor debe coincidir con la expresión regular/^[a-z0-9]*$/. --iam-credentials-reuse-apikey(bool)-
Este parámetro indica si se deben reutilizar el ID de servicio y la clave de API para futuras operaciones de lectura. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
--secret-rotation(RotationPolicy)-
Este campo indica si Secrets Manager rota los secretos automáticamente. Tipos de secreto admitidos: username_password, private_cert, public_cert, iam_credentials, custom_credentials. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-rotation=@path/to/file.json. --imported-cert-certificate(cadena)-
Contenido codificado con PEM del certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/. --imported-cert-intermediate(cadena)-
(Opcional) Certificado intermedio codificado con PEM y asociado al certificado raíz. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/. --imported-cert-private-key(cadena)-
(Opcional) Clave privada codificada con PEM que se debe asociar con el certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/. --imported-cert-managed-csr(ImportedCertificateManagedCsr)-
Los datos especificados para crear el CSR y la clave privada. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--imported-cert-managed-csr=@path/to/file.json. --kv-data(correlación genérica)-
Datos de carga útil de un secreto de valor de clave. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud mínima es
1item.Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--kv-data=@path/to/file.json. --private-cert-template-name(cadena)-
El nombre de la plantilla de certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/. --certificate-common-name(cadena)-
El nombre común (CN) representa el nombre de servidor que está protegido por el certificado SSL. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud mínima es de
4caracteres. --certificate-alt-names(serie[])-
Con el campo Nombre alternativo de asunto, puede especificar nombres de host adicionales que proteger con un único certificado SSL. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/^(.*?)$/. La longitud máxima es de99elementos. La longitud mínima es de0artículos. --private-cert-ip-sans(cadena)-
Nombres alternativos de asunto de IP que se van a definir para el certificado de CA, en una lista delimitada por comas. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
2048caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-uri-sans(cadena)-
Nombres alternativos de asunto de URI que definir para el certificado de CA, en una lista delimitada por comas. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
2048caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-other-sans(serie[])-
El identificador de objeto (OID) personalizado o los nombres alternativos de asunto UTF8-string que definir para el certificado de CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-csr(cadena)-
Solicitud de firma de certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
4096caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/. --private-cert-format(cadena)-
El formato de los datos devueltos. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
pem,pem_bundle. --private-cert-private-key-format(cadena)-
Formato de la clave privada generada. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
El valor predeterminado es
der. Los valores permitidos son:der,pkcs8. --private-cert-exclude-cn-from-sans(bool)-
Este parámetro controla si el nombre común se excluye de los nombres alternativos de asunto (SAN). Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
--public-cert-key-algorithm(cadena)-
Identificador del algoritmo criptográfico que se utiliza para generar la clave pública asociada al certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
El valor predeterminado es
RSA2048. La longitud máxima es de8caracteres. La longitud mínima es de5caracteres. El valor debe coincidir con la expresión regular/^(RSA2048|RSA4096|ECDSA256|ECDSA384)$/. --public-cert-ca(cadena)-
El nombre de la configuración de la entidad emisora de certificados. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --public-cert-dns(cadena)-
El nombre de la configuración del proveedor de DNS. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --public-cert-bundle-ca(bool)-
Este campo indica si el certificado emitido se empaqueta con certificados intermedios. Establezca
falsepara que el archivo de certificado contenga sólo el certificado emitido. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.El valor predeterminado es
true. --secret-source-service(ServiceCredentialsSecretSourceService)-
Las propiedades necesarias para crear las credenciales de servicio para la instancia de servicio de origen especificada. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-source-service=@path/to/file.json. --username-password-username(cadena)-
El nombre de usuario que se asigna a un secreto de
username_password. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
64caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/[A-Za-z0-9+-=.]*/. --username-password-password(cadena)-
La contraseña que se asigna a un secreto
username_password. Si omite este parámetro, Secrets Manager genera una nueva contraseña aleatoria para el secreto. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
256caracteres. La longitud mínima es de6caracteres. El valor debe coincidir con la expresión regular/.{6,256}/. --username-password-policy(PasswordGenerationPolicy)-
Política para contraseñas generadas automáticamente. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--username-password-policy=@path/to/file.json. --custom-credentials-configuration(cadena)-
El nombre de la configuración de credenciales personalizadas. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[a-zA-Z0-9]([-a-zA-Z0-9\\-_\\.]*)?$/. --custom-credentials-parameters(correlación genérica)-
Los parámetros que se pasan al motor de credenciales personalizadas. Los tipos permitidos son cadena, entero y booleano. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--custom-credentials-parameters=@path/to/file.json.
Ejemplo
Solicitud de ejemplo
ibmcloud secrets-manager secret-create \
--secret-name example-arbitrary-secret \
--secret-type arbitrary \
--arbitrary-payload example-secret-data
ibmcloud secrets-manager secrets
Liste los secretos que están disponibles en la instancia de Secrets Manager. Nota: Si la opción --all-pages no está establecida, el mandato sólo recuperará una única página de la colección.
ibmcloud secrets-manager secrets [--offset OFFSET] [--limit LIMIT] [--sort SORT] [--search SEARCH] [--groups GROUPS] [--secret-types SECRET-TYPES] [--match-all-labels MATCH-ALL-LABELS]
Opciones de comando
--offset(int64)-
El número de secretos a omitir.
El valor predeterminado es
0. El valor máximo es10000000. El valor mínimo es0. --limit(int64)-
El número de secretos a listar.
El valor predeterminado es
200. El valor máximo es1000. El valor mínimo es1. --sort(cadena)-
Ordene una colección de secretos por el campo especificado en orden ascendente. Para ordenar en orden descendente utilice el carácter
-.La longitud máxima es de
17caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^-?(id|created_at|updated_at|retrieved_at|expiration_date|secret_type|name)$/. --search(cadena)-
Filtre secretos que contienen la serie especificada en uno o más de estos campos: "id", "name", "description", "labels", "secret_type".
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --groups(serie[])-
Filtrar secretos por grupos. Proporcione los ID de los grupos por los que filtrar.
Los elementos de lista deben coincidir con la expresión regular
/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/. La longitud máxima es de201elementos. La longitud mínima es de0artículos. --secret-types(serie[])-
Filtrar secretos por tipos. Proporcione los tipos de secreto por los que filtrar.
Los elementos de lista permitidos son:
arbitrary,iam_credentials,imported_cert,kv,private_cert,public_cert,service_credentials,username_password,custom_credentials. La longitud máxima es de9elementos. La longitud mínima es de0artículos. --match-all-labels(serie[])-
Filtrar secretos por etiquetas. Proporcione las etiquetas por las que filtrar.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de30elementos. La longitud mínima es de0artículos. --all-pages(bool)-
Invoque varias solicitudes para visualizar todas las páginas de la colección para los secretos.
Ejemplo
ibmcloud secrets-manager secrets \
--offset 0 \
--limit 10 \
--sort created_at \
--search example \
--groups default,cac40995-c37a-4dcb-9506-472869077634 \
--secret-types arbitrary,iam_credentials,imported_cert,kv,private_cert,public_cert,service_credentials,username_password,custom_credentials \
--match-all-labels dev,us-south
Salida de ejemplo
Ejemplo de respuesta de recopilación de metadatos secretos
{
"first" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?limit=50"
},
"previous" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=50&limit=50"
},
"last" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=200&limit=50"
},
"limit" : 50,
"next" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets?offset=150&limit=50"
},
"offset" : 100,
"secrets" : [ {
"alt_names" : [ "s1.example.com", "*.s2.example.com" ],
"common_name" : "example.com",
"created_at" : "2020-10-05T21:33:11Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"crn" : "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:a931192f-b6a9-43d6-a59a-834f3003af7b",
"custom_metadata" : {
"metadata_custom_key" : "metadata_custom_value"
},
"description" : "Extended description for this secret.",
"downloaded" : false,
"expiration_date" : "2030-10-05T11:49:42Z",
"id" : "a931192f-b6a9-43d6-a59a-834f3003af7b",
"intermediate_included" : true,
"issuer" : "DigiCert",
"key_algorithm" : "RSA2048",
"labels" : [ "dev", "us-south" ],
"locks_total" : 0,
"name" : "my-imported-certificate",
"private_key_included" : true,
"secret_group_id" : "bfc0a4a9-3d58-4fda-945b-76756af516aa",
"serial_number" : "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd",
"secret_type" : "imported_cert",
"signing_algorithm" : "SHA256-RSA",
"state" : 1,
"state_description" : "active",
"updated_at" : "2022-10-05T21:33:11Z",
"validity" : {
"not_before" : "2020-10-05T21:33:11Z",
"not_after" : "2030-10-05T11:49:42Z"
},
"versions_total" : 1
}, {
"alt_names" : [ "s1.example.com", "*.s2.example.com" ],
"common_name" : "example.com",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"created_at" : "2020-10-05T21:33:11Z",
"crn" : "crn:v1:bluemix:public:secrets-manager:us-south:a/a5ebf2570dcaedf18d7ed78e216c263a:f1bc94a6-64aa-4c55-b00f-f6cd70e4b2ce:secret:cb7a2502-8ede-47d6-b5b6-1b7af6b6f563",
"custom_metadata" : {
"metadata_custom_key" : "metadata_custom_value"
},
"description" : "Extended description for this secret.",
"downloaded" : false,
"expiration_date" : "2030-10-05T11:49:42Z",
"id" : "f075f0b3-71e4-4a14-b60f-0b38b855a3d1",
"issuer" : "Lets Encrypt",
"issuance_info" : {
"auto_rotated" : false,
"ordered_on" : "2022-10-06T06:15:55Z",
"state" : 1,
"state_description" : "active"
},
"bundle_certs" : true,
"ca" : "lets-encrypt-config",
"dns" : "cloud-internet-services-config",
"key_algorithm" : "RSA2048",
"labels" : [ "dev", "us-south" ],
"updated_at" : "2022-10-05T21:33:11Z",
"locks_total" : 0,
"name" : "my-public-certificate",
"rotation" : {
"auto_rotate" : true,
"rotate_keys" : true
},
"secret_group_id" : "bfc0a4a9-3d58-4fda-945b-76756af516aa",
"serial_number" : "03:e2:c6:e4:0b:7d:30:e2:e2:78:1b:b9:13:fd:f0:fc:89:dd",
"secret_type" : "public_cert",
"signing_algorithm" : "SHA256-RSA",
"state" : 1,
"state_description" : "active",
"validity" : {
"not_before" : "2020-10-05T21:33:11Z",
"not_after" : "2030-10-05T11:49:42Z"
},
"versions_total" : 1
} ],
"total_count" : 232
}
Predeterminado JMESPath
Se aplicará una consulta JMESPath a la salida de este comando de forma predeterminada, si el usuario no proporciona una. La consulta exacta dependerá del escenario y del formato de salida solicitado. Puede ver la condición de cada consulta predeterminada de JMESPath en la siguiente tabla:
| Respuesta | Salida | Consulta |
|---|---|---|
| Correcto | Valor predeterminado |
|
| Tabla | secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date} |
|
| Error | Valor predeterminado |
|
| Tabla | secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date} |
|
| Todas las páginas | Valor predeterminado |
|
| Tabla | secrets[*].{Name:name,ID:id,Secret_Type:secret_type,secret_group_id:secret_group_id,State:state_description,Locks:locks_total,Expiration:expiration_date} |
Si se proporciona una consulta personalizada de JMESPath, sustituirá a cualquiera de las JMESPath de la tabla anterior.
ibmcloud secrets-manager secret
Obtenga un secreto y sus detalles especificando el ID del secreto.
Una solicitud correcta devuelve los datos secretos asociados con el secreto, junto con otros metadatos. Para ver sólo los detalles de un secreto especificado sin recuperar su valor, utilice la operación Obtener metadatos secretos.
ibmcloud secrets-manager secret --id ID
Opciones de comando
--id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
Ejemplo
ibmcloud secrets-manager secret \
--id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
ibmcloud secrets-manager secret-delete
Suprimir un secreto especificando el ID del secreto.
ibmcloud secrets-manager secret-delete --id ID [--force-delete=FORCE-DELETE]
Opciones de comando
--id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --force-delete(bool)-
Establézcalo en
truepara forzar la eliminación del secreto. Solo está disponible para el tipo de secreto de credenciales personalizadas.El valor predeterminado es
false.
Ejemplo
ibmcloud secrets-manager secret-delete \
--id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--force-delete=false
ibmcloud secrets-manager secret-metadata
Obtener los metadatos de un secreto especificando el ID del secreto.
ibmcloud secrets-manager secret-metadata --id ID
Opciones de comando
--id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
Ejemplo
ibmcloud secrets-manager secret-metadata \
--id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
ibmcloud secrets-manager secret-metadata-update
Actualice los metadatos de un secreto, como su nombre o descripción.
ibmcloud secrets-manager secret-metadata-update --id ID [--name NAME] [--description DESCRIPTION] [--labels LABELS] [--custom-metadata CUSTOM-METADATA] [--expiration-date EXPIRATION-DATE] [--ttl TTL] [--rotation ROTATION] [--imported-cert-managed-csr IMPORTED-CERT-MANAGED-CSR] [--password-generation-policy PASSWORD-GENERATION-POLICY] [--custom-credentials-parameters CUSTOM-CREDENTIALS-PARAMETERS]
Opciones de comando
--id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --secret-metadata-patch(correlación genérica)-
Contenido de Merge-Patch de JSON para update_secret_metadata. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-metadata-patch=@path/to/file.json. --name(cadena)-
Un nombre legible por personas que asignar al secreto. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
La longitud máxima es de
256caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/. --description(cadena)-
Una descripción ampliada de su secreto. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
La longitud máxima es de
1024caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --labels(serie[])-
Etiquetas que puede utilizar para buscar secretos en la instancia. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de30elementos. La longitud mínima es de0artículos. --custom-metadata(correlación genérica)-
Los metadatos secretos que un usuario puede personalizar. Debe ser una cadena JSON o una ruta a un archivo JSON. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--custom-metadata=@path/to/file.json. --expiration-date(strfmt.DateTime)-
La fecha en que caduca el material secreto. El formato de fecha sigue el formato 'RFC 3339'. Tipos de secreto soportados: arbitrary, username_password. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
--ttl(cadena)-
Tiempo de vida (TTL) o duración del arrendamiento que asignar a las credenciales que se generan. Tipos de secreto admitidos: iam_credentials, service_credentials, custom_credentials. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de1caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --rotation(RotationPolicy)-
Este campo indica si Secrets Manager rota los secretos automáticamente. Tipos de secreto admitidos: username_password, private_cert, public_cert, iam_credentials, custom_credentials. Debe ser una cadena JSON o una ruta a un archivo JSON. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--rotation=@path/to/file.json. --imported-cert-managed-csr(ImportedCertificateManagedCsr)-
Los datos especificados para crear el CSR y la clave privada. Debe ser una cadena JSON o una ruta a un archivo JSON. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--imported-cert-managed-csr=@path/to/file.json. --password-generation-policy(PasswordGenerationPolicyPatch)-
Parche de política para contraseñas generadas automáticamente. Las propiedades de política que se incluyen en el parche se actualizan.\nLas propiedades no incluidas en el parche permanecen inalteradas. Debe ser una cadena JSON o una ruta a un archivo JSON. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--password-generation-policy=@path/to/file.json. --custom-credentials-parameters(correlación genérica)-
Los parámetros que se pasan al motor de credenciales personalizadas. Los tipos permitidos son cadena, entero y booleano. Debe ser una cadena JSON o una ruta a un archivo JSON. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-metadata-patch". Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--custom-credentials-parameters=@path/to/file.json.
Ejemplo
ibmcloud secrets-manager secret-metadata-update \
--id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--name updated-arbitrary-secret-name-example \
--description 'updated Arbitrary Secret description' \
--labels dev,us-south \
--custom-metadata '{"anyKey": "anyValue"}' \
--expiration-date 2033-04-12T23:20:50.520Z
ibmcloud secrets-manager secret-action-create
Cree una acción de secreto. Esta operación admite las siguientes acciones:.
ibmcloud secrets-manager secret-action-create --id ID [--secret-action-prototype SECRET-ACTION-PROTOTYPE | --secret-action-type SECRET-ACTION-TYPE]
Opciones de comando
--id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --secret-action-prototype(SecretActionPrototype)-
El cuerpo de solicitud para especificar las propiedades de la acción de secreto. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-action-prototype=@path/to/file.json. --secret-action-type(cadena)-
Tipo de acción de secreto. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-action-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
public_cert_action_validate_dns_challenge,private_cert_action_revoke_certificate.
Ejemplo
Solicitud de ejemplo
ibmcloud secrets-manager secret-action-create --id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --secret-action-type=public_cert_action_validate_dns_challenge
ibmcloud secrets-manager secret-action-create \
--id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--secret-action-prototype='{"action_type": "public_cert_action_validate_dns_challenge"}'
ibmcloud secrets-manager secret-by-name
Obtenga un secreto y sus detalles especificando el Nombre y el Tipo del secreto.
Una solicitud correcta devuelve los datos secretos asociados con el secreto, junto con otros metadatos. Para ver sólo los detalles de un secreto especificado sin recuperar su valor, utilice la operación Obtener metadatos secretos.
ibmcloud secrets-manager secret-by-name --secret-type SECRET-TYPE --name NAME --secret-group-name SECRET-GROUP-NAME
Opciones de comando
--secret-type(cadena)-
El tipo de secreto. Obligatorio.
Los valores permitidos son:
arbitrary,iam_credentials,imported_cert,kv,private_cert,public_cert,service_credentials,username_password,custom_credentials. --name(cadena)-
Un nombre legible por personas que asignar al secreto. Para proteger tu intimidad, no utilices datos personales, como tu nombre o tu ubicación, como nombre de tu secreto. Obligatorio.
La longitud máxima es de
256caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^\\w(([\\w-.]+)?\\w)?$/. --secret-group-name(cadena)-
El nombre del grupo de secretos. Obligatorio.
La longitud máxima es de
64caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/.
Ejemplo
ibmcloud secrets-manager secret-by-name \
--secret-type arbitrary \
--name my-secret \
--secret-group-name default
Versiones secretas
Cree y gestione las versiones de sus secretos.
ibmcloud secrets-manager secret-version-create
Cree una nueva versión de secreto.
ibmcloud secrets-manager secret-version-create --secret-id SECRET-ID [--secret-version-prototype SECRET-VERSION-PROTOTYPE | --arbitrary-payload ARBITRARY-PAYLOAD --secret-version-custom-metadata SECRET-VERSION-CUSTOM-METADATA --secret-version-version-custom-metadata SECRET-VERSION-VERSION-CUSTOM-METADATA --secret-version-restore-from-version SECRET-VERSION-RESTORE-FROM-VERSION --imported-cert-certificate IMPORTED-CERT-CERTIFICATE --imported-cert-intermediate IMPORTED-CERT-INTERMEDIATE --imported-cert-private-key IMPORTED-CERT-PRIVATE-KEY --kv-data KV-DATA --private-cert-csr PRIVATE-CERT-CSR --public-cert-rotation PUBLIC-CERT-ROTATION --username-password-password USERNAME-PASSWORD-PASSWORD]
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --secret-version-prototype(SecretVersionPrototype)-
Especifique las propiedades para la nueva versión de secreto. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-version-prototype=@path/to/file.json. --arbitrary-payload(cadena)-
Los datos secretos que se asignan a un secreto
arbitrary. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
1000000caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --secret-version-custom-metadata(correlación genérica)-
Los metadatos secretos que un usuario puede personalizar. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-version-custom-metadata=@path/to/file.json. --secret-version-version-custom-metadata(correlación genérica)-
Los metadatos de la versión de secreto que un usuario puede personalizar. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-version-version-custom-metadata=@path/to/file.json. --secret-version-restore-from-version(cadena)-
Un identificador UUID, o alias de versión secreta
currentoprevious. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/. --imported-cert-certificate(cadena)-
Contenido codificado con PEM del certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/. --imported-cert-intermediate(cadena)-
(Opcional) Certificado intermedio codificado con PEM y asociado al certificado raíz. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/. --imported-cert-private-key(cadena)-
(Opcional) Clave privada codificada con PEM que se debe asociar con el certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/. --kv-data(correlación genérica)-
Datos de carga útil de un secreto de valor de clave. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.
La longitud mínima es
1item.Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--kv-data=@path/to/file.json. --private-cert-csr(cadena)-
Solicitud de firma de certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
4096caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/. --public-cert-rotation(PublicCertificateRotationObject)-
Define el objeto de rotación que se utiliza para rotar manualmente los certificados públicos. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--public-cert-rotation=@path/to/file.json. --username-password-password(cadena)-
La contraseña que se asigna a un secreto
username_password. Si omite este parámetro, Secrets Manager genera una nueva contraseña aleatoria para el secreto. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
256caracteres. La longitud mínima es de6caracteres. El valor debe coincidir con la expresión regular/.{6,256}/.
Ejemplo
Solicitud de ejemplo
ibmcloud secrets-manager secret-version-create --secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --arbitrary-payload='updated secret credentials' --secret-version-custom-metadata='{"anyKey": "anyValue"}'
ibmcloud secrets-manager secret-version-create \
--secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--secret-version-prototype='{"payload": "updated secret credentials", "custom_metadata": {"anyKey": "anyValue"}, "version_custom_metadata": {"anyKey": "anyValue"}}'
ibmcloud secrets-manager secret-versions
Listar las versiones de un secreto.
Una solicitud correcta devuelve la lista de versiones de un secreto, junto con los metadatos de cada versión.
ibmcloud secrets-manager secret-versions --secret-id SECRET-ID
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
Ejemplo
ibmcloud secrets-manager secret-versions \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
Salida de ejemplo
Ejemplo de respuesta de recopilación de metadatos de versión secreta
{
"versions" : [ {
"created_at" : "2022-06-27T11:58:15Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"expiration_date" : "2030-10-05T11:49:42Z",
"id" : "bc656587-8fda-4d05-9ad8-b1de1ec7e712",
"payload_available" : true,
"secret_group_id" : "67d025e1-0248-418f-83ba-deb0ebfb9b4a",
"secret_id" : "67d025e1-0248-418f-83ba-deb0ebfb9b4a",
"secret_name" : "example-imported-certificate",
"secret_type" : "imported_cert",
"serial_number" : "38:eb:01:a3:22:e9:de:55:24:56:9b:14:cb:e2:f3:e3:e2:fb:f5:18",
"validity" : {
"not_after" : "2030-10-05T11:49:42Z",
"not_before" : "2022-06-27T11:58:15Z"
},
"version_custom_metadata" : {
"custom_version_key" : "custom_version_value"
}
} ],
"total_count" : 1
}
Predeterminado JMESPath
Se aplicará una consulta JMESPath a la salida de este comando de forma predeterminada, si el usuario no proporciona una. La consulta exacta dependerá del escenario y del formato de salida solicitado. Puede ver la condición de cada consulta predeterminada de JMESPath en la siguiente tabla:
| Respuesta | Salida | Consulta |
|---|---|---|
| Correcto | Valor predeterminado |
|
| Tabla | versions[*] |
|
| Error | Valor predeterminado |
|
| Tabla | versions[*] |
|
| Todas las páginas | Valor predeterminado |
|
| Tabla | versions[*] |
Si se proporciona una consulta personalizada de JMESPath, sustituirá a cualquiera de las JMESPath de la tabla anterior.
ibmcloud secrets-manager secret-version
Obtener una versión de un secreto especificando el ID de la versión. Puede utilizar los alias current o previous para hacer referencia a la versión secreta actual o anterior.
Una solicitud satisfactoria devuelve los datos de secretos que están asociados con la versión especificada de su secreto, junto con otros metadatos.
ibmcloud secrets-manager secret-version --secret-id SECRET-ID --id ID
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID de la versión del secreto. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.
Ejemplo
ibmcloud secrets-manager secret-version \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id eb4cf24d-9cae-424b-945e-159788a5f535
ibmcloud secrets-manager secret-version-data-delete
Borra los datos de una versión secreta especificando su ID de versión.
Esta operación está disponible para los siguientes tipos de secreto:
iam_credentials sólo la versión actual
custom_credentials: tanto la versión actual como las anteriores.
ibmcloud secrets-manager secret-version-data-delete --secret-id SECRET-ID --id ID
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID de la versión del secreto. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.
Ejemplo
ibmcloud secrets-manager secret-version-data-delete \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id eb4cf24d-9cae-424b-945e-159788a5f535
ibmcloud secrets-manager secret-version-metadata
Obtener los metadatos de una versión secreta especificando el ID de la versión. Puede utilizar los alias current o previous para hacer referencia a la versión secreta actual o anterior.
Una solicitud satisfactoria devuelve los metadatos asociados a la versión especificada de su secreto.
ibmcloud secrets-manager secret-version-metadata --secret-id SECRET-ID --id ID
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID de la versión del secreto. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/.
Ejemplo
ibmcloud secrets-manager secret-version-metadata \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id eb4cf24d-9cae-424b-945e-159788a5f535
ibmcloud secrets-manager secret-version-metadata-update
Actualice los metadatos personalizados de una versión de secreto.
ibmcloud secrets-manager secret-version-metadata-update --secret-id SECRET-ID --id ID [--version-custom-metadata VERSION-CUSTOM-METADATA]
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID de la versión del secreto. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/. --secret-version-metadata-patch(correlación genérica)-
Contenido de Merge-Patch de JSON para update_secret_version_metadata. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-version-metadata-patch=@path/to/file.json. --version-custom-metadata(correlación genérica)-
Los metadatos de la versión de secreto que un usuario puede personalizar. Debe ser una cadena JSON o una ruta a un archivo JSON. Esta opción proporciona un valor para un subcampo de la opción JSON "secret-version-metadata-patch". Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--version-custom-metadata=@path/to/file.json.
Ejemplo
ibmcloud secrets-manager secret-version-metadata-update \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id eb4cf24d-9cae-424b-945e-159788a5f535 \
--version-custom-metadata '{"anyKey": "anyValue"}'
ibmcloud secrets-manager secret-version-action-create
Cree una acción de versión de secreto. Esta operación admite las siguientes acciones:
private_cert_action_revoke_certificate: Revocar una versión de un certificado privado.
ibmcloud secrets-manager secret-version-action-create --secret-id SECRET-ID --id ID [--secret-version-action-prototype SECRET-VERSION-ACTION-PROTOTYPE | --secret-version-action-type SECRET-VERSION-ACTION-TYPE]
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID de la versión del secreto. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/. --secret-version-action-prototype(SecretVersionActionPrototype)-
El cuerpo de solicitud para especificar las propiedades de la acción para crear una versión de secreto. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--secret-version-action-prototype=@path/to/file.json. --secret-version-action-type(cadena)-
El tipo de acción de versión de secreto. Esta opción proporciona un valor para un subcampo de la opción JSON 'secret-version-action-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
private_cert_action_revoke_certificate.
Ejemplo
Solicitud de ejemplo
ibmcloud secrets-manager secret--version-action-create --secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 --id=eb4cf24d-9cae-424b-945e-159788a5f535 --secret-version-action-type=private_cert_action_revoke_certificate
ibmcloud secrets-manager secret-version-action-create \
--secret-id=0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id=eb4cf24d-9cae-424b-945e-159788a5f535 \
--secret-version-action-prototype='{"action_type": "private_cert_action_revoke_certificate"}'
Salida de ejemplo
El cuerpo de solicitud de la acción para revocar versiones de certificados privados.
{
"action_type" : "private_cert_action_revoke_certificate",
"revocation_time_seconds" : 1667982994
}
Tareas secretas
Supervise y actualice las tareas que pertenecen a su secreto.
ibmcloud secrets-manager secret-tasks
Lista de tareas secretas.
Tipos de secreto admitidos: custom_credentials.
ibmcloud secrets-manager secret-tasks --secret-id SECRET-ID
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
Ejemplo
ibmcloud secrets-manager secret-tasks \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
Salida de ejemplo
Ejemplo de respuesta para listar todas las tareas.
{
"tasks" : [ {
"id" : "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"creation_date" : "2022-04-12T23:20:50.52Z",
"last_update_date" : "2022-04-12T23:21:40.22Z",
"updated_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"type" : "create_credentials",
"status" : "queued",
"trigger" : "secret_creation",
"secret_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
"secret_version_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5"
} ]
}
ibmcloud secrets-manager secret-task
Obtenga una tarea de un secreto y sus detalles especificando el ID de la tarea.
Una solicitud correcta devuelve la tarea asociada a su secreto.
Tipos de secreto admitidos: custom_credentials.
ibmcloud secrets-manager secret-task --secret-id SECRET-ID --id ID
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID que identifica de forma única su tarea. Obligatorio.
La longitud debe ser de
44caracteres. El valor debe coincidir con la expresión regular/^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
Ejemplo
ibmcloud secrets-manager secret-task \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95
Salida de ejemplo
Ejemplo de respuesta con una Tarea Secreta.
{
"id" : "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21",
"creation_date" : "2022-04-12T23:20:50.52Z",
"last_update_date" : "2022-04-12T23:20:50.52Z",
"updated_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21",
"type" : "create_credentials",
"status" : "queued",
"trigger" : "secret_creation",
"secret_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
"secret_version_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5"
}
ibmcloud secrets-manager secret-task-update
Un punto final de devolución de llamada para actualizar una tarea con resultados.
Tipos de secreto admitidos: custom_credentials.
ibmcloud secrets-manager secret-task-update --secret-id SECRET-ID --id ID [--task-put TASK-PUT | --task-put-status TASK-PUT-STATUS --task-put-credentials TASK-PUT-CREDENTIALS --task-put-errors TASK-PUT-ERRORS]
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID que identifica de forma única su tarea. Obligatorio.
La longitud debe ser de
44caracteres. El valor debe coincidir con la expresión regular/^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/. --task-put(SecretTaskPrototype)-
El cuerpo de la solicitud para especificar las propiedades de la actualización de su tarea secreta. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--task-put=@path/to/file.json. --task-put-status(cadena)-
Describe el estado de la tarea de un secreto. Esta opción proporciona un valor para un subcampo de la opción JSON "task-put". Es mutuamente excluyente con esa opción.
Los valores permitidos son:
credentials_created. --task-put-credentials(CustomCredentialsNewCredentials)-
Credenciales recién creadas proporcionadas por el proveedor de credenciales. Esta opción proporciona un valor para un subcampo de la opción JSON "task-put". Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--task-put-credentials=@path/to/file.json. --task-put-errors(SecretTaskError[])-
Una colección de errores. Esta opción proporciona un valor para un subcampo de la opción JSON "task-put". Es mutuamente excluyente con esa opción.
La longitud máxima es de
10elementos. La longitud mínima es1item.Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--task-put-errors=@path/to/file.json.
Ejemplos
ibmcloud secrets-manager secret-task-update \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95 \
--task-put '{"status": "credentials_created", "credentials": {"id": "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5", "payload": {"anyKey": "anyValue"}}}'
De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:
ibmcloud secrets-manager secret-task-update \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95 \
--task-put-status credentials_created \
--task-put-credentials customCredentialsNewCredentials
Salida de ejemplo
Ejemplo de respuesta con una Tarea Secreta.
{
"id" : "sm-task-b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21",
"creation_date" : "2022-04-12T23:20:50.52Z",
"last_update_date" : "2022-04-12T23:20:50.52Z",
"updated_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-abeae11c0f21",
"type" : "create_credentials",
"status" : "queued",
"trigger" : "secret_creation",
"secret_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
"secret_version_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1a84d5"
}
ibmcloud secrets-manager secret-task-delete
Elimine una tarea especificando el ID del secreto.
Tipos de secreto admitidos: custom_credentials.
ibmcloud secrets-manager secret-task-delete --secret-id SECRET-ID --id ID
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID que identifica de forma única su tarea. Obligatorio.
La longitud debe ser de
44caracteres. El valor debe coincidir con la expresión regular/^sm-task-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.
Ejemplo
ibmcloud secrets-manager secret-task-delete \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id sm-task-a436bebd-dbbd-5c0d-ab35-1232f1234f95
Cerraduras secretas
Proteja los datos secretos adjuntando un bloqueo a una versión secreta e impidiendo cualquier modificación o supresión.
ibmcloud secrets-manager secrets-locks
Liste los secretos y sus bloqueos en la instancia de Secrets Manager. Nota: Si la opción --all-pages no está establecida, el mandato sólo recuperará una única página de la colección.
ibmcloud secrets-manager secrets-locks [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--groups GROUPS]
Opciones de comando
--offset(int64)-
El número de secretos a omitir.
El valor predeterminado es
0. El valor máximo es10000000. El valor mínimo es0. --limit(int64)-
El número de secretos a listar.
El valor predeterminado es
200. El valor máximo es1000. El valor mínimo es1. --search(cadena)-
Filtrar bloqueos que contengan la serie especificada en el campo "nombre".
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --groups(serie[])-
Filtrar secretos por grupos. Proporcione los ID de los grupos por los que filtrar.
Los elementos de lista deben coincidir con la expresión regular
/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/. La longitud máxima es de201elementos. La longitud mínima es de0artículos. --all-pages(bool)-
Invoque varias solicitudes para visualizar todas las páginas de la colección para los bloqueos de secretos.
Ejemplo
ibmcloud secrets-manager secrets-locks \
--offset 0 \
--limit 10 \
--search example \
--groups default,cac40995-c37a-4dcb-9506-472869077634
Salida de ejemplo
Respuesta de ejemplo para listar todos los secretos y bloqueos
{
"secrets_locks" : [ {
"secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
"secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
"secret_type" : "imported_cert",
"secret_name" : "example-imported-certificate",
"versions" : [ {
"version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
"version_alias" : "current",
"locks" : [ "lock-example-1", "lock-example-2" ]
} ]
} ],
"first" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?limit=50"
},
"previous" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=50&limit=50"
},
"last" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=200&limit=50"
},
"limit" : 50,
"next" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets_locks?offset=150&limit=50"
},
"offset" : 100,
"total_count" : 1
}
Predeterminado JMESPath
Se aplicará una consulta JMESPath a la salida de este comando de forma predeterminada, si el usuario no proporciona una. La consulta exacta dependerá del escenario y del formato de salida solicitado. Puede ver la condición de cada consulta predeterminada de JMESPath en la siguiente tabla:
| Respuesta | Salida | Consulta |
|---|---|---|
| Correcto | Valor predeterminado |
|
| Tabla | secrets_locks[*] |
|
| Error | Valor predeterminado |
|
| Tabla | secrets_locks[*] |
|
| Todas las páginas | Valor predeterminado |
|
| Tabla | secrets_locks[*] |
Si se proporciona una consulta personalizada de JMESPath, sustituirá a cualquiera de las JMESPath de la tabla anterior.
ibmcloud secrets-manager secret-locks
Lista los bloqueos asociados a un secreto especificado. Nota: Si la opción --all-pages no está establecida, el mandato sólo recuperará una única página de la colección.
ibmcloud secrets-manager secret-locks --id ID [--offset OFFSET] [--limit LIMIT] [--sort SORT] [--search SEARCH]
Opciones de comando
--id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --offset(int64)-
El número de bloqueos que se van a omitir.
El valor predeterminado es
0. El valor máximo es1000. El valor mínimo es0. --limit(int64)-
El número de secretos con bloqueos a listar.
El valor predeterminado es
25. El valor máximo es100. El valor mínimo es1. --sort(cadena)-
Ordene una colección de bloqueos por el campo especificado en orden ascendente. Para ordenar en orden descendente utilice el carácter
-.La longitud máxima es de
17caracteres. La longitud mínima es de4caracteres. El valor debe coincidir con la expresión regular/^-?(created_at|updated_at|name)$/. --search(cadena)-
Filtrar bloqueos que contengan la serie especificada en el campo "nombre".
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --all-pages(bool)-
Invoque varias solicitudes para visualizar todas las páginas de la colección para los bloqueos de secretos.
Ejemplo
ibmcloud secrets-manager secret-locks \
--id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--offset 0 \
--limit 10 \
--sort name \
--search example
Salida de ejemplo
Ejemplo de cuerpo de respuesta para listar bloqueos secretos
{
"first" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?limit=50"
},
"previous" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=50&limit=50"
},
"limit" : 50,
"last" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=200&limit=50"
},
"locks" : [ {
"attributes" : {
"key" : "value"
},
"created_at" : "2022-06-27T11:58:15Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"description" : "Lock for consumer 1.",
"name" : "lock-example-1",
"secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
"secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
"secret_version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
"secret_version_alias" : "current",
"updated_at" : "2022-10-05T21:33:11Z"
}, {
"created_at" : "2022-06-27T11:58:15Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"description" : "Lock for consumer 2.",
"name" : "lock-example-2",
"secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
"secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
"secret_version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
"secret_version_alias" : "current",
"updated_at" : "2022-10-05T21:33:11Z"
} ],
"next" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/locks?offset=150&limit=50"
},
"offset" : 100,
"total_count" : 2
}
ibmcloud secrets-manager secret-locks-bulk-create
Crea un bloqueo sobre la versión actual de un secreto.
Se puede utilizar un bloqueo para evitar que un secreto se suprima o se modifique mientras las aplicaciones lo estén utilizando. Una solicitud correcta adjunta un nuevo bloqueo al secreto, o sustituye un bloqueo del mismo nombre si ya existe. Además, puede utilizar esta operación para borrar cualquier bloqueo coincidente en un secreto utilizando una de las siguientes modalidades de bloqueo opcionales:
remove_previous: Elimina otros bloqueos con nombres coincidentes si se encuentran en la versión anterior del secreto.\nremove_previous_and_delete: lleva a cabo la misma función queremove_previous, pero también suprime de forma permanente los datos de la versión secreta anterior si no tiene ningún bloqueo.
ibmcloud secrets-manager secret-locks-bulk-create --id ID --locks LOCKS [--mode MODE]
Opciones de comando
--id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --locks(SecretLockPrototype[])-
Los datos de bloqueo que se deben adjuntar a una versión de secreto. Obligatorio.
La longitud máxima es de
1000elementos. La longitud mínima es de0artículos.Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--locks=@path/to/file.json. --mode(cadena)-
Establecer la modalidad de bloqueo. Valores permitidos:
remove_previous, yremove_previous_and_delete. Utiliceremove_previouspara crear un bloqueo que borre los bloqueos existentes con nombres coincidentes. Utiliceremove_previous_and_deletepara borrar también los datos de la versión anterior.Los valores permitidos son:
remove_previous,remove_previous_and_delete.
Ejemplo
ibmcloud secrets-manager secret-locks-bulk-create \
--id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--locks '[{"name": "lock-example-1", "description": "lock for consumer 1", "attributes": {"anyKey": "anyValue"}}]' \
--mode remove_previous
Salida de ejemplo
Ejemplo de cuerpo de respuesta para crear bloqueos secretos
{
"secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
"secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
"secret_type" : "arbitrary",
"versions" : [ {
"version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
"version_alias" : "current",
"locks" : [ "lock-3", "lock-4" ],
"payload_available" : true
}, {
"version_id" : "5bf89b0c-df55-c8d5-7ad6-8816951c6784",
"version_alias" : "previous",
"locks" : [ "lock-example-1", "lock-example-2" ],
"payload_available" : true
} ]
}
ibmcloud secrets-manager secret-locks-bulk-delete
Suprimir todos los bloqueos o un subconjunto de los bloqueos asociados a una versión de un secreto.
Para suprimir sólo un subconjunto de los bloqueos, añada un parámetro de consulta con una coma para separar la lista de nombres de bloqueo:
Ejemplo: ?name=lock-example-1,lock-example-2.
Nota: Un secreto se considera desbloqueado y solo se puede suprimir después de eliminar todos sus bloqueos. Para determinar si un secreto contiene bloqueos, compruebe el campo locks_total que se devuelve como
parte de los metadatos del secreto.
ibmcloud secrets-manager secret-locks-bulk-delete --id ID [--name NAME]
Opciones de comando
--id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --name(serie[])-
Especifique los nombres de los bloqueos de secretos que se van a suprimir.
Los elementos de lista deben coincidir con la expresión regular
/^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$/. La longitud máxima es de1000elementos. La longitud mínima es1item.
Ejemplo
ibmcloud secrets-manager secret-locks-bulk-delete \
--id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--name lock-example-1
Salida de ejemplo
Ejemplo de cuerpo de respuesta para crear bloqueos secretos
{
"secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
"secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
"secret_type" : "arbitrary",
"versions" : [ {
"version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
"version_alias" : "current",
"locks" : [ "lock-3", "lock-4" ],
"payload_available" : true
}, {
"version_id" : "5bf89b0c-df55-c8d5-7ad6-8816951c6784",
"version_alias" : "previous",
"locks" : [ "lock-example-1", "lock-example-2" ],
"payload_available" : true
} ]
}
ibmcloud secrets-manager secret-version-locks
Liste los bloqueos que están asociados con una versión de secreto especificada. Nota: Si la opción --all-pages no está establecida, el mandato sólo recuperará una única página de la colección.
ibmcloud secrets-manager secret-version-locks --secret-id SECRET-ID --id ID [--offset OFFSET] [--limit LIMIT] [--sort SORT] [--search SEARCH]
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID de la versión del secreto. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/. --offset(int64)-
El número de bloqueos que se van a omitir.
El valor predeterminado es
0. El valor máximo es1000. El valor mínimo es0. --limit(int64)-
El número de secretos con bloqueos a listar.
El valor predeterminado es
25. El valor máximo es100. El valor mínimo es1. --sort(cadena)-
Ordene una colección de bloqueos por el campo especificado en orden ascendente. Para ordenar en orden descendente utilice el carácter
-.La longitud máxima es de
17caracteres. La longitud mínima es de4caracteres. El valor debe coincidir con la expresión regular/^-?(created_at|updated_at|name)$/. --search(cadena)-
Filtrar bloqueos que contengan la serie especificada en el campo "nombre".
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --all-pages(bool)-
Invoque varias solicitudes para visualizar todas las páginas de la colección para los bloqueos de versión de secreto.
Ejemplo
ibmcloud secrets-manager secret-version-locks \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id eb4cf24d-9cae-424b-945e-159788a5f535 \
--offset 0 \
--limit 10 \
--sort name \
--search example
Salida de ejemplo
Respuesta de ejemplo para listar bloqueos de versión de secreto
{
"first" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?limit=50"
},
"previous" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=50&limit=50"
},
"last" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=200&limit=50"
},
"limit" : 50,
"locks" : [ {
"attributes" : {
"key" : "value"
},
"created_at" : "2022-06-27T11:58:15Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"description" : "lock for consumer 1.",
"name" : "lock-example-1",
"secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
"secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
"secret_version_alias" : "current",
"secret_version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
"updated_at" : "2022-10-05T21:33:11Z"
} ],
"next" : {
"href" : "https://us-south.secrets-maanger.cloud.ibm.com/88b75b20-aa21-4174-85c9-1feb3cc93c9a/api/v2/secrets/0cf4addb-7a90-410b-a3a7-a15bbe2b7909/versions/7bf3814d-58f8-4df8-9cbd-f6860e4ca973/locks?offset=150&limit=50"
},
"offset" : 100,
"total_count" : 1
}
ibmcloud secrets-manager secret-version-locks-bulk-create
Crea un bloqueo sobre la versión especificada de un secreto.
Se puede utilizar un bloqueo para evitar que un secreto se suprima o se modifique mientras las aplicaciones lo estén utilizando. Una solicitud correcta adjunta un nuevo bloqueo al secreto, o sustituye un bloqueo del mismo nombre si ya existe. Además, puede utilizar esta operación para borrar cualquier bloqueo coincidente en un secreto utilizando una de las siguientes modalidades de bloqueo opcionales:
remove_previous: Elimina otros bloqueos con nombres coincidentes si se encuentran en la versión anterior del secreto.remove_previous_and_delete: lleva a cabo la misma función queremove_previous, pero también suprime de forma permanente los datos de la versión secreta anterior si no tiene ningún bloqueo.
ibmcloud secrets-manager secret-version-locks-bulk-create --secret-id SECRET-ID --id ID --locks LOCKS [--mode MODE]
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID de la versión del secreto. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/. --locks(SecretLockPrototype[])-
Los datos de bloqueo que se deben adjuntar a una versión de secreto. Obligatorio.
La longitud máxima es de
1000elementos. La longitud mínima es de0artículos.Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--locks=@path/to/file.json. --mode(cadena)-
Establecer la modalidad de bloqueo. Valores permitidos:
remove_previous, yremove_previous_and_delete. Utiliceremove_previouspara crear un bloqueo que borre los bloqueos existentes con nombres coincidentes. Utiliceremove_previous_and_deletepara borrar también los datos de la versión anterior.Los valores permitidos son:
remove_previous,remove_previous_and_delete.
Ejemplo
ibmcloud secrets-manager secret-version-locks-bulk-create \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id eb4cf24d-9cae-424b-945e-159788a5f535 \
--locks '[{"name": "lock-example-1", "description": "lock for consumer 1", "attributes": {"anyKey": "anyValue"}}]' \
--mode remove_previous
Salida de ejemplo
Ejemplo de cuerpo de respuesta para crear bloqueos secretos
{
"secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
"secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
"secret_type" : "arbitrary",
"versions" : [ {
"version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
"version_alias" : "current",
"locks" : [ "lock-3", "lock-4" ],
"payload_available" : true
}, {
"version_id" : "5bf89b0c-df55-c8d5-7ad6-8816951c6784",
"version_alias" : "previous",
"locks" : [ "lock-example-1", "lock-example-2" ],
"payload_available" : true
} ]
}
ibmcloud secrets-manager secret-version-locks-bulk-delete
Suprimir todos los bloqueos o un subconjunto de los bloqueos asociados a la versión especificada de un secreto.
Para suprimir sólo un subconjunto de los bloqueos, añada un parámetro de consulta con una coma para separar la lista de nombres de bloqueo:
Ejemplo: ?name=lock-example-1,lock-example-2.
Nota: Un secreto se considera desbloqueado y solo se puede suprimir después de que se hayan eliminado todos sus bloqueos. Para determinar si un secreto contiene bloqueos, compruebe el campo locks_total que se
devuelve como parte de los metadatos del secreto.
ibmcloud secrets-manager secret-version-locks-bulk-delete --secret-id SECRET-ID --id ID [--name NAME]
Opciones de comando
--secret-id(cadena)-
El ID del secreto. Obligatorio.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/. --id(cadena)-
El ID de la versión del secreto. Obligatorio.
La longitud máxima es de
36caracteres. La longitud mínima es de7caracteres. El valor debe coincidir con la expresión regular/^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|current|previous)$/. --name(serie[])-
Especifique los nombres de los bloqueos de secretos que se van a suprimir.
Los elementos de lista deben coincidir con la expresión regular
/^[a-zA-Z]{1}[a-zA-Z0-9-_.]{1,63}$/. La longitud máxima es de1000elementos. La longitud mínima es1item.
Ejemplo
ibmcloud secrets-manager secret-version-locks-bulk-delete \
--secret-id 0b5571f7-21e6-42b7-91c5-3f5ac9793a46 \
--id eb4cf24d-9cae-424b-945e-159788a5f535 \
--name lock-example-1
Salida de ejemplo
Ejemplo de cuerpo de respuesta para crear bloqueos secretos
{
"secret_id" : "0cf4addb-7a90-410b-a3a7-a15bbe2b7909",
"secret_group_id" : "d8371728-95c8-4c12-b2af-1af98adb9e41",
"secret_type" : "arbitrary",
"versions" : [ {
"version_id" : "7bf3814d-58f8-4df8-9cbd-f6860e4ca973",
"version_alias" : "current",
"locks" : [ "lock-3", "lock-4" ],
"payload_available" : true
}, {
"version_id" : "5bf89b0c-df55-c8d5-7ad6-8816951c6784",
"version_alias" : "previous",
"locks" : [ "lock-example-1", "lock-example-2" ],
"payload_available" : true
} ]
}
Configuraciones
Cree y gestione configuraciones para que pueda trabajar con tipos específicos de secretos.
ibmcloud secrets-manager configuration-create
Añade una configuración al tipo de secreto especificado.
Utilice esta operación para definir las configuraciones necesarias para crear certificados públicos (public_cert), certificados privados (private_cert), secretos de credenciales IAM (iam_credentials)
y secretos de credenciales personalizados (custom_credentials).
Puede añadir varias configuraciones para su instancia de la siguiente manera:
- Una única configuración para las credenciales IAM.
- Hasta 10 configuraciones de CA para certificados públicos.
- Hasta 10 configuraciones DNS para certificados públicos.
- Hasta 10 configuraciones de CA raíz para certificados privados.
- Hasta 10 configuraciones de CA intermediaria para certificados privados.
- Hasta 10 configuraciones de plantilla de certificado para certificados privados.
ibmcloud secrets-manager configuration-create [--configuration-prototype CONFIGURATION-PROTOTYPE | --config-type CONFIG-TYPE --name NAME --public-cert-cloud-internet-services-apikey PUBLIC-CERT-CLOUD-INTERNET-SERVICES-APIKEY --public-cert-cloud-internet-services-crn PUBLIC-CERT-CLOUD-INTERNET-SERVICES-CRN --public-cert-classic-infrastructure-username PUBLIC-CERT-CLASSIC-INFRASTRUCTURE-USERNAME --public-cert-classic-infrastructure-password PUBLIC-CERT-CLASSIC-INFRASTRUCTURE-PASSWORD --public-cert-lets-encrypt-environment PUBLIC-CERT-LETS-ENCRYPT-ENVIRONMENT --public-cert-lets-encrypt-private-key PUBLIC-CERT-LETS-ENCRYPT-PRIVATE-KEY --public-cert-lets-encrypt-preferred-chain PUBLIC-CERT-LETS-ENCRYPT-PREFERRED-CHAIN --private-cert-crypto-key PRIVATE-CERT-CRYPTO-KEY --private-cert-max-ttl PRIVATE-CERT-MAX-TTL --private-cert-crl-expiry PRIVATE-CERT-CRL-EXPIRY --private-cert-crl-disabled=PRIVATE-CERT-CRL-DISABLED --private-cert-crl-distribution-points-encoded=PRIVATE-CERT-CRL-DISTRIBUTION-POINTS-ENCODED --private-cert-issuing-certificate-urls-encoded=PRIVATE-CERT-ISSUING-CERTIFICATE-URLS-ENCODED --certificate-common-name CERTIFICATE-COMMON-NAME --certificate-alt-names CERTIFICATE-ALT-NAMES --private-cert-ip-sans PRIVATE-CERT-IP-SANS --private-cert-uri-sans PRIVATE-CERT-URI-SANS --private-cert-other-sans PRIVATE-CERT-OTHER-SANS --private-cert-ttl PRIVATE-CERT-TTL --private-cert-format PRIVATE-CERT-FORMAT --private-cert-private-key-format PRIVATE-CERT-PRIVATE-KEY-FORMAT --private-cert-private-key-type PRIVATE-CERT-PRIVATE-KEY-TYPE --private-cert-private-key-bits PRIVATE-CERT-PRIVATE-KEY-BITS --private-cert-max-path-length PRIVATE-CERT-MAX-PATH-LENGTH --private-cert-exclude-cn-from-sans=PRIVATE-CERT-EXCLUDE-CN-FROM-SANS --private-cert-permitted-dns-domains PRIVATE-CERT-PERMITTED-DNS-DOMAINS --private-cert-subject-organizational-unit PRIVATE-CERT-SUBJECT-ORGANIZATIONAL-UNIT --private-cert-subject-organization PRIVATE-CERT-SUBJECT-ORGANIZATION --private-cert-subject-country PRIVATE-CERT-SUBJECT-COUNTRY --private-cert-subject-locality PRIVATE-CERT-SUBJECT-LOCALITY --private-cert-subject-province PRIVATE-CERT-SUBJECT-PROVINCE --private-cert-subject-street-address PRIVATE-CERT-SUBJECT-STREET-ADDRESS --private-cert-subject-postal-code PRIVATE-CERT-SUBJECT-POSTAL-CODE --private-cert-serial-number PRIVATE-CERT-SERIAL-NUMBER --private-cert-signing-method PRIVATE-CERT-SIGNING-METHOD --private-cert-issuer PRIVATE-CERT-ISSUER --private-cert-ca-name PRIVATE-CERT-CA-NAME --private-cert-allowed-secret-groups PRIVATE-CERT-ALLOWED-SECRET-GROUPS --private-cert-allow-localhost=PRIVATE-CERT-ALLOW-LOCALHOST --private-cert-allowed-domains PRIVATE-CERT-ALLOWED-DOMAINS --private-cert-allowed-domains-template=PRIVATE-CERT-ALLOWED-DOMAINS-TEMPLATE --private-cert-allow-bare-domains=PRIVATE-CERT-ALLOW-BARE-DOMAINS --private-cert-allow-subdomains=PRIVATE-CERT-ALLOW-SUBDOMAINS --private-cert-allow-glob-domains=PRIVATE-CERT-ALLOW-GLOB-DOMAINS --private-cert-allow-wildcard=PRIVATE-CERT-ALLOW-WILDCARD --private-cert-allow-any-name=PRIVATE-CERT-ALLOW-ANY-NAME --private-cert-enforce-hostname=PRIVATE-CERT-ENFORCE-HOSTNAME --private-cert-allow-ip-sans=PRIVATE-CERT-ALLOW-IP-SANS --private-cert-allowed-uri-sans PRIVATE-CERT-ALLOWED-URI-SANS --private-cert-allowed-other-sans PRIVATE-CERT-ALLOWED-OTHER-SANS --private-cert-server-flag=PRIVATE-CERT-SERVER-FLAG --private-cert-client-flag=PRIVATE-CERT-CLIENT-FLAG --private-cert-code-signing-flag=PRIVATE-CERT-CODE-SIGNING-FLAG --private-cert-email-protection-flag=PRIVATE-CERT-EMAIL-PROTECTION-FLAG --private-cert-key-usage PRIVATE-CERT-KEY-USAGE --private-cert-ext-key-usage PRIVATE-CERT-EXT-KEY-USAGE --private-cert-ext-key-usage-oids PRIVATE-CERT-EXT-KEY-USAGE-OIDS --private-cert-use-csr-common-name=PRIVATE-CERT-USE-CSR-COMMON-NAME --private-cert-use-cse-sans=PRIVATE-CERT-USE-CSE-SANS --private-cert-require-cn=PRIVATE-CERT-REQUIRE-CN --private-cert-policy-identifiers PRIVATE-CERT-POLICY-IDENTIFIERS --private-cert-basic-constraints-valid-for-non-ca=PRIVATE-CERT-BASIC-CONSTRAINTS-VALID-FOR-NON-CA --private-cert-not-before-duration PRIVATE-CERT-NOT-BEFORE-DURATION --iam-credentials-apikey IAM-CREDENTIALS-APIKEY --iam-credentials-apikey-disabled=IAM-CREDENTIALS-APIKEY-DISABLED --custom-credentials-apikey-ref CUSTOM-CREDENTIALS-APIKEY-REF --custom-credentials-code-engine CUSTOM-CREDENTIALS-CODE-ENGINE --configuration-task-timeout CONFIGURATION-TASK-TIMEOUT]
Opciones de comando
--configuration-prototype(ConfigurationPrototype)-
Un archivo JSON que contiene los detalles necesarios para crear una configuración. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--configuration-prototype=@path/to/file.json. --config-type(cadena)-
Tipo de configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
public_cert_configuration_dns_cloud_internet_services,public_cert_configuration_dns_classic_infrastructure,public_cert_configuration_ca_lets_encrypt,private_cert_configuration_root_ca,private_cert_configuration_intermediate_ca,private_cert_configuration_template,iam_credentials_configuration,custom_credentials_configuration. --name(cadena)-
Nombre exclusivo legible para una persona que asignar a la configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$/. --public-cert-cloud-internet-services-apikey(cadena)-
Una clave de API de IBM Cloud que puede listar dominios en la instancia de Cloud Internet Services y añadir registros DNS. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --public-cert-cloud-internet-services-crn(cadena)-
Un CRN que identifica de forma exclusiva un recurso de IBM Cloud. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
512caracteres. La longitud mínima es de9caracteres. El valor debe coincidir con la expresión regular/^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/. --public-cert-classic-infrastructure-username(cadena)-
Nombre de usuario que está asociado a la cuenta de infraestructura clásica. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --public-cert-classic-infrastructure-password(cadena)-
Clave de API de la infraestructura clásica. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --public-cert-lets-encrypt-environment(cadena)-
La configuración del entorno CA de Let's Encrypt. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
production,staging. --public-cert-lets-encrypt-private-key(cadena)-
La clave privada codificada en PEM de su cuenta de Let's Encrypt. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/. --public-cert-lets-encrypt-preferred-chain(cadena)-
La cadena preferida con un emisor que coincide con este nombre común de asunto. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
30caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-crypto-key(PrivateCertificateCryptoKey)-
Los datos asociados a una clave criptográfica en formato JSON. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--private-cert-crypto-key=@path/to/file.json. --private-cert-max-ttl(cadena)-
Tiempo máximo de vida (TTL) para los certificados creados por esta CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --private-cert-crl-expiry(cadena)-
Tiempo restante hasta que caduque la lista de revocación de certificados (CRL). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --private-cert-crl-disabled(bool)-
Este campo inhabilita o habilita la compilación de listas de revocación de certificados (CRL). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-crl-distribution-points-encoded(bool)-
Este campo determina si se deben codificar los puntos de distribución de la lista de revocación de certificados (CRL) en los certificados emitidos por esta entidad emisora de certificados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-issuing-certificate-urls-encoded(bool)-
Este campo determina si se debe codificar el URL del certificado emisor en los certificados emitidos por esta entidad emisora de certificados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--certificate-common-name(cadena)-
El nombre común (CN) representa el nombre de servidor que está protegido por el certificado SSL. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de4caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --certificate-alt-names(serie[])-
Con el campo Nombre alternativo de asunto, puede especificar nombres de host adicionales que proteger con un único certificado SSL. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/^(.*?)$/. La longitud máxima es de99elementos. La longitud mínima es de0artículos. --private-cert-ip-sans(cadena)-
Nombres alternativos de asunto de IP que se van a definir para el certificado de CA, en una lista delimitada por comas. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
2048caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-uri-sans(cadena)-
Nombres alternativos de asunto de URI que definir para el certificado de CA, en una lista delimitada por comas. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
2048caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-other-sans(serie[])-
El identificador de objeto (OID) personalizado o los nombres alternativos de asunto UTF8-string que definir para el certificado de CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-ttl(cadena)-
El tiempo de vida solicitado (TTL) para los certificados creados por esta CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --private-cert-format(cadena)-
El formato de los datos devueltos. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
pem,pem_bundle. --private-cert-private-key-format(cadena)-
Formato de la clave privada generada. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
El valor predeterminado es
der. Los valores permitidos son:der,pkcs8. --private-cert-private-key-type(cadena)-
El tipo de clave privada que se va a generar. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
rsa,ec. --private-cert-private-key-bits(int64)-
Número de bits que utilizar para generar la clave privada. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
El valor máximo es
4096. El valor mínimo es224. --private-cert-max-path-length(int64)-
La longitud máxima de la ruta a codificar en el certificado generado.
-1significa que no hay límite. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.El valor máximo es
10. El valor mínimo es-1. --private-cert-exclude-cn-from-sans(bool)-
Este parámetro controla si el nombre común se excluye de los nombres alternativos de asunto (SAN). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-permitted-dns-domains(serie[])-
Los dominios o subdominios de DNS permitidos para los certificados que se van a firmar y emitir mediante este certificado de CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-subject-organizational-unit(serie[])-
Los valores de unidad organizativa (OU) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-organization(serie[])-
Los valores de Organización (O) que se deben definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-country(serie[])-
Los valores de País (C) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-locality(serie[])-
Los valores de Localidad (L) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-province(serie[])-
Los valores de Provincia (ST) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-street-address(serie[])-
Los valores de dirección postal que se deben definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-postal-code(serie[])-
Los valores de código postal a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-serial-number(cadena)-
El valor solicitado para el atributo
serialNumber( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ) que se encuentra en el nombre distinguido (DN) del certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.The maximum length is
64characters. The minimum length is32characters. The value must match regular expression/[^a-fA-F0-9]/. --private-cert-signing-method(cadena)-
Método de firma que se debe utilizar con esta entidad emisora de certificados para generar certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
internal,external. --private-cert-issuer(cadena)-
Nombre distinguido que identifica la entidad que ha firmado y emitido el certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-ca-name(cadena)-
Nombre de la entidad emisora de certificados intermedia. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/. --private-cert-allowed-secret-groups(cadena)-
Este campo limita la creación de certificados privados únicamente a los grupos de secretos que especifique el usuario. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
1024caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-allow-localhost(bool)-
Este campo indica si se permite incluir
localhostcomo uno de los nombres comunes solicitados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción. --private-cert-allowed-domains(serie[])-
Los dominios que se deben definir para la plantilla de certificado. Esta propiedad se utiliza junto con las opciones
allow_bare_domainsyallow_subdomains. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-allowed-domains-template(bool)-
Este campo indica si se permite que los dominios que se proporcionan en el campo
allowed_domainscontengan plantillas de listas de control de acceso (ACL). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción. --private-cert-allow-bare-domains(bool)-
Este campo indica si se permite a los clientes solicitar certificados privados que coincidan con el valor de los dominios reales en el certificado final. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-allow-subdomains(bool)-
Este campo indica si se permite a los clientes solicitar certificados privados con nombres comunes (CN) que son subdominios de los CN permitidos por las otras opciones de plantilla de certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-allow-glob-domains(bool)-
Este campo indica si se permiten patrones glob en los nombres que se especifican en el campo
allowed_domains. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción. --private-cert-allow-wildcard(bool)-
Este campo indica si se permite la emisión de certificados con comodines RFC 6125 en el campo CN. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-allow-any-name(bool)-
Este campo indica si se permite a los clientes solicitar un certificado privado que coincida con cualquier nombre común. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-enforce-hostname(bool)-
Este campo indica si se deben aplicar solo nombres de host válidos para nombres comunes, nombres alternativos de sujeto DNS y la sección de host de direcciones de correo electrónico. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-allow-ip-sans(bool)-
Este campo indica si se permite a los clientes solicitar un certificado privado con nombres alternativos de sujeto IP. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-allowed-uri-sans(serie[])-
Nombres alternativos de asunto de URI para permitir certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-allowed-other-sans(serie[])-
Identificador de objeto (OID) personalizado o nombres alternativos de asunto (SAN) UTF8-string para permitir certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-server-flag(bool)-
Este campo indica si los certificados privados se marcan para el uso del servidor. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-client-flag(bool)-
Este campo indica si los certificados privados se marcan para el uso del cliente. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-code-signing-flag(bool)-
Este campo indica si los certificados privados se marcan para el uso de firma de código. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-email-protection-flag(bool)-
Este campo indica si los certificados privados se marcan para el uso de protección de correo electrónico. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-key-usage(serie[])-
Restricción de uso de clave permitida para definir certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/^[a-zA-Z]+$/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-ext-key-usage(serie[])-
Restricción de uso de clave ampliada permitida en certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/^[a-zA-Z]+$/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-ext-key-usage-oids(serie[])-
Una lista de identificadores de objetos (OID) de uso ampliado de clave. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-use-csr-common-name(bool)-
Este campo determina si se debe utilizar el nombre común (CN) de una solicitud de firma de certificado (CSR). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-use-cse-sans(bool)-
Este campo determina si se deben utilizar los nombres alternativos de asunto (SAN) de una solicitud de firma de certificado (CSR). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-require-cn(bool)-
Este campo indica si se necesita un nombre común para crear un certificado privado. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-policy-identifiers(serie[])-
Una lista de identificadores de objetos de política (OID). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-basic-constraints-valid-for-non-ca(bool)-
Este campo indica si se debe marcar la extensión Restricciones básicas de un certificado privado emitido como válido para certificados no CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-not-before-duration(cadena)-
La duración en segundos por la que se antedata la propiedad
not_beforede un certificado privado emitido. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --iam-credentials-apikey(cadena)-
Clave de API que se utiliza para establecer el motor iam_credentials. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
60caracteres. La longitud mínima es de5caracteres. El valor debe coincidir con la expresión regular/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/. --iam-credentials-apikey-disabled(bool)-
Este parámetro indica si la configuración de la clave de API está desactivada. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
El valor predeterminado es
false. --custom-credentials-apikey-ref(cadena)-
El ID secreto de credenciales de IAM que se utiliza para establecer una configuración personalizada del motor de credenciales. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
La longitud debe ser de
36caracteres. El valor debe coincidir con la expresión regular/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/. --custom-credentials-code-engine(CustomCredentialsConfigurationCodeEngine)-
Los parámetros necesarios para configurar Code Engine. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--custom-credentials-code-engine=@path/to/file.json. --configuration-task-timeout(cadena)-
Especifica el tiempo máximo permitido para que se complete una tarea de Code Engine. Una vez transcurrido este tiempo, el estado de la tarea cambiará a fallido. El valor mínimo es 5 minutos y el máximo es 24 horas. El tiempo de espera predeterminado es 10 minutos. El valor puede ser un número entero que especifique el número de segundos, o la representación en forma de cadena de una duración, como
10mo2h. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-prototype'. Es mutuamente excluyente con esa opción.La longitud máxima es de
6caracteres. La longitud mínima es de1caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/.
Ejemplo
Solicitud de ejemplo
ibmcloud secrets-manager configuration-create --config-type=private_cert_configuration_root_ca \
--name=example-root-CA --certificate-common-name=example.com --private-cert-max-ttl=7365
ibmcloud secrets-manager configuration-create --config-type=private_cert_configuration_root_ca --name=example-root-CA-HSM \
--certificate-common-name=example.com --private-cert-max-ttl=73654 \
--private-cert-crypto-key='{ "provider": { "type": "hyper_protect_crypto_services", "instance_crn": "crn:v1:bluemix:public:hs-crypto:us-south:a/791f3fb10486421e97aa8512f18b7e65:b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5::","pin_iam_credentials_secret_id": "14a7aff4-432d-11dc-a0f0-56a5b473394f", "private_keystore_id": "14a7aff4-432d-11dc-a0f0-56a5b473394f" }, "label": "cli-created", "allow_generate_key": true }'
ibmcloud secrets-manager configuration-create \
--configuration-prototype='{"config_type": "private_cert_configuration_root_ca", "name": "example-root-CA", "max_ttl": "43830h", "crl_expiry": "72h", "crl_disable": false, "crl_distribution_points_encoded": true, "issuing_certificates_urls_encoded": true, "common_name": "example.com", "alt_names": ["alt-name-1","alt-name-2"], "ip_sans": "127.0.0.1", "uri_sans": "https://www.example.com/test", "other_sans": ["1.2.3.5.4.3.201.10.4.3;utf8:test@example.com"], "ttl": "2190h", "format": "pem", "private_key_format": "der", "key_type": "rsa", "key_bits": 4096, "max_path_length": -1, "exclude_cn_from_sans": false, "permitted_dns_domains": ["exampleString"], "ou": ["exampleString"], "organization": ["exampleString"], "country": ["exampleString"], "locality": ["exampleString"], "province": ["exampleString"], "street_address": ["exampleString"], "postal_code": ["exampleString"], "serial_number": "d9:be:fe:35:ba:09:42:b5:35:ba:09:42:b5"}'
ibmcloud secrets-manager configurations
Liste las configuraciones que están disponibles en la instancia de Secrets Manager. Nota: Si la opción --all-pages no está establecida, el mandato sólo recuperará una única página de la colección.
ibmcloud secrets-manager configurations [--offset OFFSET] [--limit LIMIT] [--sort SORT] [--search SEARCH] [--secret-types SECRET-TYPES]
Opciones de comando
--offset(int64)-
El número de configuraciones a omitir.
El valor predeterminado es
0. El valor máximo es1000. El valor mínimo es0. --limit(int64)-
El número de configuraciones a listar.
El valor predeterminado es
200. El valor máximo es1000. El valor mínimo es1. --sort(cadena)-
Ordene una colección de configuraciones por el campo especificado en orden ascendente. Para ordenar en orden descendente utilice el carácter
-.La longitud máxima es de
17caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^-?(config_type|secret_type|name)$/. --search(cadena)-
Filtre las configuraciones que contienen la serie especificada en uno o más de los campos: "name", "config_type", "secret_type".
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --secret-types(serie[])-
Filtrar configuraciones por tipos de secreto. Especifique uno o más de los siguientes tipos de secreto: iam_credentials, public_cert, private_cert o custom_credentials.
Los elementos de lista permitidos son:
iam_credentials,private_cert,public_cert,custom_credentials. La longitud máxima es4elementos. La longitud mínima es de0artículos. --all-pages(bool)-
Invoque varias solicitudes para visualizar todas las páginas de la colección para las configuraciones.
Ejemplo
ibmcloud secrets-manager configurations \
--offset 0 \
--limit 10 \
--sort config_type \
--search example \
--secret-types iam_credentials,private_cert,public_cert,custom_credentials
Salida de ejemplo
Respuesta de ejemplo para configurar la recopilación de metadatos
{
"first" : {
"href" : "https://something.com"
},
"next" : {
"href" : "https://something.com"
},
"previous" : {
"href" : "https://something.com"
},
"last" : {
"href" : "https://something.com"
},
"limit" : 25,
"offset" : 0,
"configurations" : [ {
"config_type" : "public_cert_configuration_ca_lets_encrypt",
"created_at" : "2022-06-27T11:58:15Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"lets_encrypt_environment" : "production",
"name" : "lets-encrypt-config",
"secret_type" : "public_cert",
"updated_at" : "2022-10-05T21:33:11Z"
}, {
"config_type" : "public_cert_configuration_dns_cloud_internet_services",
"created_at" : "2022-06-27T11:58:15Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"name" : "cloud-internet-services-config",
"secret_type" : "public_cert",
"updated_at" : "2022-10-05T21:33:11Z"
}, {
"config_type" : "public_cert_configuration_dns_classic_infrastructure",
"created_at" : "2022-06-27T11:58:15Z",
"created_by" : "iam-ServiceId-e4a2f0a4-3c76-4bef-b1f2-fbeae11c0f21",
"name" : "classic-infrastructure-config",
"secret_type" : "public_cert",
"updated_at" : "2022-10-05T21:33:11Z"
}, {
"common_name" : "ibm.com",
"config_type" : "private_cert_configuration_root_ca",
"created_at" : "2022-11-08T11:22:19Z",
"created_by" : "iam-ServiceId-1ba95813-1b0f-45c1-b46c-969a5fda08d1",
"expiration_date" : "2030-03-31T01:13:07Z",
"key_bits" : 2048,
"key_type" : "rsa",
"name" : "internal-root",
"secret_type" : "private_cert",
"status" : "configured",
"updated_at" : "2022-11-08T11:22:19Z"
}, {
"common_name" : "ibm.com",
"config_type" : "private_cert_configuration_intermediate_ca",
"created_at" : "2022-11-08T11:22:19Z",
"created_by" : "iam-ServiceId-1ba95813-1b0f-45c1-b46c-969a5fda08d1",
"expiration_date" : "2030-03-31T01:13:07Z",
"issuer" : "internal-root",
"name" : "example-intermediate-CA",
"key_bits" : 2048,
"key_type" : "rsa",
"secret_type" : "private_cert",
"status" : "configured",
"updated_at" : "2022-11-08T11:22:19Z"
}, {
"certificate_authority" : "inter-1",
"config_type" : "private_cert_configuration_template",
"created_at" : "2022-11-08T11:22:23Z",
"created_by" : "iam-ServiceId-8e54a866-476b-46cd-ba05-dbeae5f1d984",
"name" : "example-certificate-template",
"secret_type" : "private_cert",
"updated_at" : "2022-11-08T11:22:23Z"
}, {
"api_key_ref" : "a2f9c2e4-a3a8-c508-2bed-fcb7c26843ca",
"code_engine" : {
"job_name" : "code-engine-job-name",
"project_id" : "12345678-5120-4a18-832a-4ba122496633",
"region" : "us-south"
},
"code_engine_key_ref" : "sm-access-24bc230d-9855-4825-99b5-ac78be81959c",
"config_type" : "custom_credentials_configuration",
"created_at" : "2025-03-23T08:35:29.27Z",
"created_by" : "IBMid-000002CM7E",
"name" : "my_config",
"schema" : {
"credentials" : [ {
"format" : "type:string",
"name" : "token"
} ],
"parameters" : [ {
"env_variable_name" : "SM_USER_NAME_VALUE",
"format" : "type:string",
"name" : "user_name"
}, {
"env_variable_name" : "SM_SCOPE_VALUE",
"format" : "type:enum[admin|user]",
"name" : "scope"
}, {
"env_variable_name" : "SM_EXPIRES_VALUE",
"format" : "type:integer",
"name" : "expires"
} ]
},
"secret_type" : "custom_credentials",
"task_timeout" : "10m",
"updated_at" : "2025-03-23T08:35:29.27Z"
} ],
"total_count" : 7
}
Predeterminado JMESPath
Se aplicará una consulta JMESPath a la salida de este comando de forma predeterminada, si el usuario no proporciona una. La consulta exacta dependerá del escenario y del formato de salida solicitado. Puede ver la condición de cada consulta predeterminada de JMESPath en la siguiente tabla:
| Respuesta | Salida | Consulta |
|---|---|---|
| Correcto | Valor predeterminado |
|
| Tabla | configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at} |
|
| Error | Valor predeterminado |
|
| Tabla | configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at} |
|
| Todas las páginas | Valor predeterminado |
|
| Tabla | configurations[*].{Created_At:created_at,Name:name,Config_Type:config_type,Secret_Type:secret_type,Created_By:created_by,Updated_At:updated_at} |
Si se proporciona una consulta personalizada de JMESPath, sustituirá a cualquiera de las JMESPath de la tabla anterior.
ibmcloud secrets-manager configuration
Obtener una configuración especificando su nombre.
Una solicitud correcta devuelve los detalles de la configuración.
ibmcloud secrets-manager configuration --name NAME [--config-type CONFIG-TYPE]
Opciones de comando
--name(cadena)-
Nombre de la configuración. Obligatorio.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --config-type(cadena)-
El tipo de configuración de esta configuración - utilice esta cabecera para resolver 300 respuestas de error.
Los valores permitidos son:
public_cert_configuration_dns_cloud_internet_services,public_cert_configuration_dns_classic_infrastructure,public_cert_configuration_ca_lets_encrypt,private_cert_configuration_root_ca,private_cert_configuration_intermediate_ca,private_cert_configuration_template,iam_credentials_configuration,custom_credentials_configuration.
Ejemplo
ibmcloud secrets-manager configuration \
--name configuration-name \
--config-type public_cert_configuration_dns_cloud_internet_services
ibmcloud secrets-manager configuration-update
Actualizar una configuración.
ibmcloud secrets-manager configuration-update --name NAME [--api-key API-KEY] [--iam-credentials-apikey-disabled=IAM-CREDENTIALS-APIKEY-DISABLED] [--private-cert-max-ttl PRIVATE-CERT-MAX-TTL] [--private-cert-crl-expiry PRIVATE-CERT-CRL-EXPIRY] [--private-cert-crl-disabled=PRIVATE-CERT-CRL-DISABLED] [--private-cert-crl-distribution-points-encoded=PRIVATE-CERT-CRL-DISTRIBUTION-POINTS-ENCODED] [--private-cert-issuing-certificate-urls-encoded=PRIVATE-CERT-ISSUING-CERTIFICATE-URLS-ENCODED] [--private-cert-allowed-secret-groups PRIVATE-CERT-ALLOWED-SECRET-GROUPS] [--private-cert-ttl PRIVATE-CERT-TTL] [--private-cert-allow-localhost=PRIVATE-CERT-ALLOW-LOCALHOST] [--private-cert-allowed-domains PRIVATE-CERT-ALLOWED-DOMAINS] [--private-cert-allowed-domains-template=PRIVATE-CERT-ALLOWED-DOMAINS-TEMPLATE] [--private-cert-allow-bare-domains=PRIVATE-CERT-ALLOW-BARE-DOMAINS] [--private-cert-allow-subdomains=PRIVATE-CERT-ALLOW-SUBDOMAINS] [--private-cert-allow-glob-domains=PRIVATE-CERT-ALLOW-GLOB-DOMAINS] [--private-cert-allow-any-name=PRIVATE-CERT-ALLOW-ANY-NAME] [--private-cert-enforce-hostname=PRIVATE-CERT-ENFORCE-HOSTNAME] [--private-cert-allow-ip-sans=PRIVATE-CERT-ALLOW-IP-SANS] [--private-cert-allowed-uri-sans PRIVATE-CERT-ALLOWED-URI-SANS] [--private-cert-allowed-other-sans PRIVATE-CERT-ALLOWED-OTHER-SANS] [--private-cert-server-flag=PRIVATE-CERT-SERVER-FLAG] [--private-cert-client-flag=PRIVATE-CERT-CLIENT-FLAG] [--private-cert-code-signing-flag=PRIVATE-CERT-CODE-SIGNING-FLAG] [--private-cert-email-protection-flag=PRIVATE-CERT-EMAIL-PROTECTION-FLAG] [--private-cert-private-key-type PRIVATE-CERT-PRIVATE-KEY-TYPE] [--private-cert-private-key-bits PRIVATE-CERT-PRIVATE-KEY-BITS] [--private-cert-key-usage PRIVATE-CERT-KEY-USAGE] [--private-cert-ext-key-usage PRIVATE-CERT-EXT-KEY-USAGE] [--private-cert-ext-key-usage-oids PRIVATE-CERT-EXT-KEY-USAGE-OIDS] [--private-cert-use-csr-common-name=PRIVATE-CERT-USE-CSR-COMMON-NAME] [--private-cert-use-cse-sans=PRIVATE-CERT-USE-CSE-SANS] [--private-cert-subject-organizational-unit PRIVATE-CERT-SUBJECT-ORGANIZATIONAL-UNIT] [--private-cert-subject-organization PRIVATE-CERT-SUBJECT-ORGANIZATION] [--private-cert-subject-country PRIVATE-CERT-SUBJECT-COUNTRY] [--private-cert-subject-locality PRIVATE-CERT-SUBJECT-LOCALITY] [--private-cert-subject-province PRIVATE-CERT-SUBJECT-PROVINCE] [--private-cert-subject-street-address PRIVATE-CERT-SUBJECT-STREET-ADDRESS] [--private-cert-subject-postal-code PRIVATE-CERT-SUBJECT-POSTAL-CODE] [--private-cert-requested-serial-number PRIVATE-CERT-REQUESTED-SERIAL-NUMBER] [--private-cert-require-cn=PRIVATE-CERT-REQUIRE-CN] [--private-cert-policy-identifiers PRIVATE-CERT-POLICY-IDENTIFIERS] [--private-cert-basic-constraints-valid-for-non-ca=PRIVATE-CERT-BASIC-CONSTRAINTS-VALID-FOR-NON-CA] [--private-cert-not-before-duration PRIVATE-CERT-NOT-BEFORE-DURATION] [--public-cert-lets-encrypt-environment PUBLIC-CERT-LETS-ENCRYPT-ENVIRONMENT] [--public-cert-lets-encrypt-private-key PUBLIC-CERT-LETS-ENCRYPT-PRIVATE-KEY] [--public-cert-lets-encrypt-preferred-chain PUBLIC-CERT-LETS-ENCRYPT-PREFERRED-CHAIN] [--public-cert-cloud-internet-services-apikey PUBLIC-CERT-CLOUD-INTERNET-SERVICES-APIKEY] [--cloud-internet-services-crn CLOUD-INTERNET-SERVICES-CRN] [--public-cert-classic-infrastructure-username PUBLIC-CERT-CLASSIC-INFRASTRUCTURE-USERNAME] [--public-cert-classic-infrastructure-password PUBLIC-CERT-CLASSIC-INFRASTRUCTURE-PASSWORD] [--configuration-task-timeout CONFIGURATION-TASK-TIMEOUT] [--x-sm-accept-configuration-type X-SM-ACCEPT-CONFIGURATION-TYPE]
Opciones de comando
--name(cadena)-
Nombre de la configuración. Obligatorio.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --configuration-patch(correlación genérica)-
Contenido de Merge-Patch de JSON para update_configuration. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--configuration-patch=@path/to/file.json. --config-type(cadena)-
El tipo de configuración de esta configuración - utilice esta cabecera para resolver 300 respuestas de error.
Los valores permitidos son:
public_cert_configuration_dns_cloud_internet_services,public_cert_configuration_dns_classic_infrastructure,public_cert_configuration_ca_lets_encrypt,private_cert_configuration_root_ca,private_cert_configuration_intermediate_ca,private_cert_configuration_template,iam_credentials_configuration,custom_credentials_configuration. --api-key(cadena)-
Clave de API de IBM Cloud que puede crear y gestionar ID de servicio. A la clave de API se le debe asignar el rol de plataforma de editor en el servicio de grupos de acceso y el rol de plataforma de operador en el servicio de identidad de IAM. Para obtener más información, consulte la documentación. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
60caracteres. La longitud mínima es de5caracteres. El valor debe coincidir con la expresión regular/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/. --iam-credentials-apikey-disabled(bool)-
Este parámetro indica si la configuración de la clave de API está desactivada. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-max-ttl(cadena)-
Tiempo máximo de vida (TTL) para los certificados creados por esta CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --private-cert-crl-expiry(cadena)-
Tiempo restante hasta que caduque la lista de revocación de certificados (CRL). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --private-cert-crl-disabled(bool)-
Este campo inhabilita o habilita la compilación de listas de revocación de certificados (CRL). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-crl-distribution-points-encoded(bool)-
Este campo determina si se deben codificar los puntos de distribución de la lista de revocación de certificados (CRL) en los certificados emitidos por esta entidad emisora de certificados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-issuing-certificate-urls-encoded(bool)-
Este campo determina si se debe codificar el URL del certificado emisor en los certificados emitidos por esta entidad emisora de certificados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-allowed-secret-groups(cadena)-
Este campo limita la creación de certificados privados únicamente a los grupos de secretos que especifique el usuario. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
1024caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-ttl(cadena)-
El tiempo de vida solicitado (TTL) para los certificados creados por esta CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --private-cert-allow-localhost(bool)-
Este campo indica si se debe permitir que se incluya 'localhost' como uno de los nombres comunes solicitados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-allowed-domains(serie[])-
Los dominios que se deben definir para la plantilla de certificado. Esta propiedad se utiliza junto con las opciones 'allow_bare_domains' y 'allow_subdomains'. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-allowed-domains-template(bool)-
Este campo indica si permite que los dominios que se proporcionan en el campo 'allowed_domains' contengan plantillas de listas de control de acceso (ACL). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-allow-bare-domains(bool)-
Este campo indica si se permite a los clientes solicitar certificados privados que coincidan con el valor de los dominios reales en el certificado final. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-allow-subdomains(bool)-
Este campo indica si se permite a los clientes solicitar certificados privados con nombres comunes (CN) que son subdominios de los CN permitidos por las otras opciones de plantilla de certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-allow-glob-domains(bool)-
Este campo indica si se deben permitir patrones glob en los nombres especificados en el campo "allowed_domains". Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-allow-any-name(bool)-
Este campo indica si se permite a los clientes solicitar un certificado privado que coincida con cualquier nombre común. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-enforce-hostname(bool)-
Este campo indica si se deben aplicar solo nombres de host válidos para nombres comunes, nombres alternativos de sujeto DNS y la sección de host de direcciones de correo electrónico. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-allow-ip-sans(bool)-
Este campo indica si se permite a los clientes solicitar un certificado privado con nombres alternativos de sujeto IP. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-allowed-uri-sans(serie[])-
Nombres alternativos de asunto de URI para permitir certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-allowed-other-sans(serie[])-
Identificador de objeto (OID) personalizado o nombres alternativos de asunto (SAN) UTF8-string para permitir certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-server-flag(bool)-
Este campo indica si los certificados privados se marcan para el uso del servidor. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-client-flag(bool)-
Este campo indica si los certificados privados se marcan para el uso del cliente. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-code-signing-flag(bool)-
Este campo indica si los certificados privados se marcan para el uso de firma de código. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-email-protection-flag(bool)-
Este campo indica si los certificados privados se marcan para el uso de protección de correo electrónico. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-private-key-type(cadena)-
El tipo de clave privada que se va a generar. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
rsa,ec. --private-cert-private-key-bits(int64)-
Número de bits que utilizar para generar la clave privada. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
El valor máximo es
4096. El valor mínimo es224. --private-cert-key-usage(serie[])-
Restricción de uso de clave permitida para definir certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/^[a-zA-Z]+$/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-ext-key-usage(serie[])-
Restricción de uso de clave ampliada permitida en certificados privados. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/^[a-zA-Z]+$/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-ext-key-usage-oids(serie[])-
Una lista de identificadores de objetos (OID) de uso ampliado de clave. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-use-csr-common-name(bool)-
Este campo determina si se debe utilizar el nombre común (CN) de una solicitud de firma de certificado (CSR). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-use-cse-sans(bool)-
Este campo determina si se deben utilizar los nombres alternativos de asunto (SAN) de una solicitud de firma de certificado (CSR). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-subject-organizational-unit(serie[])-
Los valores de unidad organizativa (OU) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-organization(serie[])-
Los valores de Organización (O) que se deben definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-country(serie[])-
Los valores de País (C) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-locality(serie[])-
Los valores de Localidad (L) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-province(serie[])-
Los valores de Provincia (ST) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-street-address(serie[])-
Los valores de dirección postal que se deben definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-postal-code(serie[])-
Los valores de código postal a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-requested-serial-number(cadena)-
Este campo está en desuso. Puede ignorar su valor. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
64caracteres. La longitud mínima es de32caracteres. El valor debe coincidir con la expresión regular/[^a-fA-F0-9]/. --private-cert-require-cn(bool)-
Este campo indica si se necesita un nombre común para crear un certificado privado. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-policy-identifiers(serie[])-
Una lista de identificadores de objetos de política (OID). Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-basic-constraints-valid-for-non-ca(bool)-
Este campo indica si se debe marcar la extensión Restricciones básicas de un certificado privado emitido como válido para certificados no CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
--private-cert-not-before-duration(cadena)-
Duración, en segundos, por la que antedatar la propiedad "not_before" de un certificado privado emitido. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --public-cert-lets-encrypt-environment(cadena)-
La configuración del entorno CA de Let's Encrypt. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
production,staging. --public-cert-lets-encrypt-private-key(cadena)-
La clave privada codificada en PEM de su cuenta de Let's Encrypt. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(^-----BEGIN PRIVATE KEY-----.*?)|(^-----BEGIN RSA PRIVATE KEY-----.*?)/. --public-cert-lets-encrypt-preferred-chain(cadena)-
La cadena preferida con un emisor que coincide con este nombre común de asunto. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
30caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --public-cert-cloud-internet-services-apikey(cadena)-
Una clave de API de IBM Cloud que puede listar dominios en la instancia de Cloud Internet Services y añadir registros DNS. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --cloud-internet-services-crn(cadena)-
Un CRN que identifica de forma exclusiva un recurso de IBM Cloud. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
512caracteres. La longitud mínima es de9caracteres. El valor debe coincidir con la expresión regular/^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/. --public-cert-classic-infrastructure-username(cadena)-
Nombre de usuario que está asociado a la cuenta de infraestructura clásica. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --public-cert-classic-infrastructure-password(cadena)-
Clave de API de la infraestructura clásica. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --configuration-task-timeout(cadena)-
Especifica el tiempo máximo permitido para que se complete una tarea de Code Engine. Una vez transcurrido este tiempo, el estado de la tarea cambiará a fallido. El valor mínimo es 5 minutos y el máximo es 24 horas. El tiempo de espera predeterminado es 10 minutos. El valor puede ser un número entero que especifique el número de segundos, o la representación en cadena de una duración, como '10m' o '2h'. Esta opción proporciona un valor para un subcampo de la opción JSON 'configuration-patch'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
6caracteres. La longitud mínima es de1caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/.
Ejemplo
ibmcloud secrets-manager configuration-update \
--name configuration-name \
--config-type public_cert_configuration_dns_cloud_internet_services \
--public-cert-cloud-internet-services-apikey 5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ \
--cloud-internet-services-crn crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::
ibmcloud secrets-manager configuration-delete
Suprimir una configuración especificando su nombre.
ibmcloud secrets-manager configuration-delete --name NAME [--config-type CONFIG-TYPE]
Opciones de comando
--name(cadena)-
Nombre de la configuración. Obligatorio.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --config-type(cadena)-
El tipo de configuración de esta configuración - utilice esta cabecera para resolver 300 respuestas de error.
Los valores permitidos son:
public_cert_configuration_dns_cloud_internet_services,public_cert_configuration_dns_classic_infrastructure,public_cert_configuration_ca_lets_encrypt,private_cert_configuration_root_ca,private_cert_configuration_intermediate_ca,private_cert_configuration_template,iam_credentials_configuration,custom_credentials_configuration.
Ejemplo
ibmcloud secrets-manager configuration-delete \
--name configuration-name \
--config-type public_cert_configuration_dns_cloud_internet_services
ibmcloud secrets-manager configuration-action-create
Cree una acción de configuración. Esta operación admite las siguientes acciones:
private_cert_configuration_action_sign_intermediate: firmar una entidad emisora de certificados intermedia.private_cert_configuration_action_sign_csr: firmar una solicitud de firma de certificado.private_cert_configuration_action_set_signed: establecer una entidad emisora de certificados intermedia firmada.private_cert_configuration_action_revoke_ca_certificate: revocar un certificado de entidad emisora de certificados intermedia firmado internamente.private_cert_configuration_action_rotate_crl: rotar la lista de revocación de certificados (CRL) de una entidad emisora de certificados intermedia.private_cert_configuration_action_rotate_intermediate: Rota un certificado de autoridad de certificación intermedio firmado internamente.
ibmcloud secrets-manager configuration-action-create --name NAME [--config-action-prototype CONFIG-ACTION-PROTOTYPE | --config-action-action-type CONFIG-ACTION-ACTION-TYPE --certificate-common-name CERTIFICATE-COMMON-NAME --certificate-alt-names CERTIFICATE-ALT-NAMES --private-cert-ip-sans PRIVATE-CERT-IP-SANS --private-cert-uri-sans PRIVATE-CERT-URI-SANS --private-cert-other-sans PRIVATE-CERT-OTHER-SANS --private-cert-ttl PRIVATE-CERT-TTL --private-cert-format PRIVATE-CERT-FORMAT --private-cert-max-path-length PRIVATE-CERT-MAX-PATH-LENGTH --private-cert-exclude-cn-from-sans=PRIVATE-CERT-EXCLUDE-CN-FROM-SANS --private-cert-permitted-dns-domains PRIVATE-CERT-PERMITTED-DNS-DOMAINS --config-action-use-csr-values=CONFIG-ACTION-USE-CSR-VALUES --private-cert-subject-organizational-unit PRIVATE-CERT-SUBJECT-ORGANIZATIONAL-UNIT --private-cert-subject-organization PRIVATE-CERT-SUBJECT-ORGANIZATION --private-cert-subject-country PRIVATE-CERT-SUBJECT-COUNTRY --private-cert-subject-locality PRIVATE-CERT-SUBJECT-LOCALITY --private-cert-subject-province PRIVATE-CERT-SUBJECT-PROVINCE --private-cert-subject-street-address PRIVATE-CERT-SUBJECT-STREET-ADDRESS --private-cert-subject-postal-code PRIVATE-CERT-SUBJECT-POSTAL-CODE --private-cert-serial-number PRIVATE-CERT-SERIAL-NUMBER --private-cert-csr PRIVATE-CERT-CSR --config-action-intermediate-certificate-authority CONFIG-ACTION-INTERMEDIATE-CERTIFICATE-AUTHORITY --imported-cert-certificate IMPORTED-CERT-CERTIFICATE] [--config-type CONFIG-TYPE]
Opciones de comando
--name(cadena)-
Nombre de la configuración. Obligatorio.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --config-action-prototype(ConfigurationActionPrototype)-
El cuerpo de solicitud para especificar las propiedades de la acción para crear una configuración. En su lugar, esta opción JSON se puede proporcionar estableciendo campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.
Proporcione una opción de serie JSON o especifique un archivo JSON del que leer proporcionando una opción de vía de acceso de archivo que empiece por un
@, por ejemplo,--config-action-prototype=@path/to/file.json. --config-type(cadena)-
El tipo de configuración de esta configuración - utilice esta cabecera para resolver 300 respuestas de error.
Los valores permitidos son:
public_cert_configuration_dns_cloud_internet_services,public_cert_configuration_dns_classic_infrastructure,public_cert_configuration_ca_lets_encrypt,private_cert_configuration_root_ca,private_cert_configuration_intermediate_ca,private_cert_configuration_template,iam_credentials_configuration,custom_credentials_configuration. --config-action-action-type(cadena)-
Tipo de acción de configuración. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
private_cert_configuration_action_rotate_crl,private_cert_configuration_action_sign_intermediate,private_cert_configuration_action_sign_csr,private_cert_configuration_action_set_signed,private_cert_configuration_action_revoke_ca_certificate,private_cert_configuration_action_rotate_intermediate. --certificate-common-name(cadena)-
El nombre común (CN) representa el nombre de servidor que está protegido por el certificado SSL. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de4caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --certificate-alt-names(serie[])-
Con el campo Nombre alternativo de asunto, puede especificar nombres de host adicionales que proteger con un único certificado SSL. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/^(.*?)$/. La longitud máxima es de99elementos. La longitud mínima es de0artículos. --private-cert-ip-sans(cadena)-
Nombres alternativos de asunto de IP que se van a definir para el certificado de CA, en una lista delimitada por comas. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
2048caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-uri-sans(cadena)-
Nombres alternativos de asunto de URI que definir para el certificado de CA, en una lista delimitada por comas. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
2048caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --private-cert-other-sans(serie[])-
El identificador de objeto (OID) personalizado o los nombres alternativos de asunto UTF8-string que definir para el certificado de CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --private-cert-ttl(cadena)-
El tiempo de vida (TTL) que se debe asignar a un certificado privado. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
10caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^[0-9]+[s,m,h,d]{0,1}$/. --private-cert-format(cadena)-
El formato de los datos devueltos. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los valores permitidos son:
pem,pem_bundle. --private-cert-max-path-length(int64)-
La longitud máxima de la ruta a codificar en el certificado generado.
-1significa que no hay límite. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.El valor máximo es
10. El valor mínimo es-1. --private-cert-exclude-cn-from-sans(bool)-
Este parámetro controla si el nombre común se excluye de los nombres alternativos de asunto (SAN). Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-permitted-dns-domains(serie[])-
Los dominios o subdominios de DNS permitidos para los certificados que se van a firmar y emitir mediante este certificado de CA. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de100elementos. La longitud mínima es de0artículos. --config-action-use-csr-values(bool)-
Este campo indica si se deben utilizar los valores de una solicitud de firma de certificado (CSR) para completar una acción de
private_cert_configuration_action_sign_csr. Si se establece entrue, entonces:
-
La información de asunto, incluidos los nombres y nombres alternativos, se conserva de la CSR en lugar de utilizar los valores que se proporcionan en los otros parámetros de esta operación.
-
Cualquier uso de clave, por ejemplo, no repudiación, que se solicita en la CSR se añade al conjunto básico de usos de clave utilizados para los certificados de CA firmados por la autoridad intermedia.
-
Las extensiones que se solicitan en el CSR se copian en el certificado privado emitido. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
--private-cert-subject-organizational-unit(serie[])-
Los valores de unidad organizativa (OU) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-organization(serie[])-
Los valores de Organización (O) que se deben definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-country(serie[])-
Los valores de País (C) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-locality(serie[])-
Los valores de Localidad (L) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-province(serie[])-
Los valores de Provincia (ST) a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-street-address(serie[])-
Los valores de dirección postal que se deben definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-subject-postal-code(serie[])-
Los valores de código postal a definir en el campo de asunto del certificado resultante. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
Los elementos de lista deben coincidir con la expresión regular
/(.*?)/. La longitud máxima es de10elementos. La longitud mínima es de0artículos. --private-cert-serial-number(cadena)-
El valor solicitado para el atributo
serialNumber( https://datatracker.ietf.org/doc/html/rfc4519#section-2.31 ) que se encuentra en el nombre distinguido (DN) del certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.The maximum length is
64characters. The minimum length is32characters. The value must match regular expression/[^a-fA-F0-9]/. --private-cert-csr(cadena)-
Solicitud de firma de certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
4096caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)$/. --config-action-intermediate-certificate-authority(cadena)-
El nombre de la configuración de la entidad emisora de certificados intermedia. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
128caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --imported-cert-certificate(cadena)-
Contenido codificado con PEM del certificado. Esta opción proporciona un valor para un subcampo de la opción JSON 'config-action-prototype'. Es mutuamente excluyente con esa opción.
La longitud máxima es de
100000caracteres. La longitud mínima es de50caracteres. El valor debe coincidir con la expresión regular/(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5}[\\s]*)/.
Ejemplos
ibmcloud secrets-manager configuration-action-create \
--name configuration-name \
--config-action-prototype '{"action_type": "private_cert_configuration_action_rotate_crl"}' \
--config-type public_cert_configuration_dns_cloud_internet_services
De forma alternativa, las opciones granulares están disponibles para los subcampos de las opciones de serie JSON:
ibmcloud secrets-manager configuration-action-create \
--name configuration-name \
--config-type public_cert_configuration_dns_cloud_internet_services \
--config-action-action-type private_cert_configuration_action_rotate_crl
Notificaciones
Habilite las notificaciones de ciclo de vida para su instancia conectándose a Event Notifications.
ibmcloud secrets-manager notifications-registration-create
Crear un registro entre una instancia de Secrets Manager y Event Notifications.
Una solicitud satisfactoria añade Secrets Manager como origen al que puede hacer referencia desde la instancia de Event Notifications. Para obtener más información sobre la habilitación de notificaciones para Secrets Manager, consulte los documentos.
ibmcloud secrets-manager notifications-registration-create --event-notifications-instance-crn EVENT-NOTIFICATIONS-INSTANCE-CRN --event-notifications-source-name EVENT-NOTIFICATIONS-SOURCE-NAME [--event-notifications-source-description EVENT-NOTIFICATIONS-SOURCE-DESCRIPTION]
Opciones de comando
--event-notifications-instance-crn(cadena)-
Un CRN que identifica de forma exclusiva un recurso de IBM Cloud. Obligatorio.
La longitud máxima es de
512caracteres. La longitud mínima es de9caracteres. El valor debe coincidir con la expresión regular/^crn:v[0-9](:([A-Za-z0-9-._~!$&'()*+,;=@\/]|%[0-9A-Z]{2})*){8}$/. --event-notifications-source-name(cadena)-
El nombre que se visualiza como un origen que está en la instancia de Event Notifications. Obligatorio.
La longitud máxima es de
256caracteres. La longitud mínima es de2caracteres. El valor debe coincidir con la expresión regular/(.*?)/. --event-notifications-source-description(cadena)-
Una descripción opcional para el origen que se encuentra en la instancia de Event Notifications.
La longitud máxima es de
1024caracteres. La longitud mínima es de0caracteres. El valor debe coincidir con la expresión regular/(.*?)/.
Ejemplo
ibmcloud secrets-manager notifications-registration-create \
--event-notifications-instance-crn crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8:: \
--event-notifications-source-name 'My Secrets Manager' \
--event-notifications-source-description 'Optional description of this source in an Event Notifications instance.'
Salida de ejemplo
Detalles de configuración de registro de notificaciones de ejemplo para Event Notifications.
{
"event_notifications_instance_crn" : "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::"
}
ibmcloud secrets-manager notifications-registration
Obtenga los detalles del registro entre la instancia de Secrets Manager y Event Notifications.
ibmcloud secrets-manager notifications-registration
Ejemplo
ibmcloud secrets-manager notifications-registration
Salida de ejemplo
Detalles de configuración de registro de notificaciones de ejemplo para Event Notifications.
{
"event_notifications_instance_crn" : "crn:v1:bluemix:public:event-notifications:us-south:a/22018f3c34ff4ff193698d15ca316946:578ad1a4-2fd8-4e66-95d5-79a842ba91f8::"
}
ibmcloud secrets-manager notifications-registration-delete
Elimine el registro entre su instancia Secrets Manager y Event Notifications.
Una solicitud satisfactoria elimina la instancia de Secrets Manager como origen en Event Notifications.
ibmcloud secrets-manager notifications-registration-delete
Ejemplo
ibmcloud secrets-manager notifications-registration-delete
ibmcloud secrets-manager notifications-registration-test
Envíe un suceso de prueba desde una instancia de Secrets Manager a una instancia de Event Notifications configurada.
Una solicitud satisfactoria envía un suceso de prueba a la instancia de Event Notifications. Para obtener más información sobre la habilitación de notificaciones para Secrets Manager, consulte los documentos.
ibmcloud secrets-manager notifications-registration-test
Ejemplo
ibmcloud secrets-manager notifications-registration-test
Ejemplos de esquema
Los ejemplos de esquema siguientes representan los datos que debe especificar para una opción de mandato. Estos ejemplos modelan la estructura de datos e incluyen valores de marcador para el tipo de valor esperado. Cuando ejecute un mandato, sustituya estos valores por los valores que se aplican a su entorno según corresponda.
ConfigurationActionPrototype
El siguiente ejemplo muestra el formato del objeto ConfigurationActionPrototype.
{
"action_type" : "private_cert_configuration_action_rotate_crl"
}
ConfigurationPrototype
El siguiente ejemplo muestra el formato del objeto ConfigurationPrototype.
{
"config_type" : "public_cert_configuration_dns_cloud_internet_services",
"name" : "example-cloud-internet-services-config",
"cloud_internet_services_apikey" : "5ipu_ykv0PMp2MhxQnDMn7VzrkSlBwi3BOI8uthi_EXZ",
"cloud_internet_services_crn" : "crn:v1:bluemix:public:internet-svcs:global:a/128e84fcca45c1224aae525d31ef2b52:009a0357-1460-42b4-b903-10580aba7dd8::"
}
CustomCredentialsConfigurationCodeEngine
El siguiente ejemplo muestra el formato del objeto CustomCredentialsConfigurationCodeEngine.
{
"job_name" : "sm-custom-cred-job",
"project_id" : "15314cc3-85b4-4338-903f-c28cdee6d005",
"region" : "us-south"
}
CustomCredentialsNewCredentials
El siguiente ejemplo muestra el formato del objeto CustomCredentialsNewCredentials.
{
"id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
"payload" : {
"anyKey" : "anyValue"
}
}
ImportedCertificateManagedCsr
El siguiente ejemplo muestra el formato del objeto ImportedCertificateManagedCsr.
{
"ou" : [ "exampleString", "anotherExampleString" ],
"organization" : [ "exampleString", "anotherExampleString" ],
"country" : [ "exampleString", "anotherExampleString" ],
"locality" : [ "exampleString", "anotherExampleString" ],
"province" : [ "exampleString", "anotherExampleString" ],
"street_address" : [ "exampleString", "anotherExampleString" ],
"postal_code" : [ "exampleString", "anotherExampleString" ],
"require_cn" : true,
"common_name" : "example.com",
"alt_names" : "alt-name-1,alt-name-2",
"ip_sans" : "1.1.1.1,2.2.2.2",
"uri_sans" : "exampleString",
"other_sans" : "2.5.4.5;UTF8:*.example.com",
"exclude_cn_from_sans" : true,
"user_ids" : "user-1,user-2",
"server_flag" : true,
"client_flag" : true,
"code_signing_flag" : true,
"email_protection_flag" : true,
"key_type" : "rsa",
"key_bits" : 4096,
"key_usage" : "DigitalSignature,KeyAgreement,KeyEncipherment",
"ext_key_usage" : "ServerAuth,ClientAuth,EmailProtection",
"policy_identifiers" : "exampleString",
"ext_key_usage_oids" : "exampleString",
"rotate_keys" : true
}
PasswordGenerationPolicy
El siguiente ejemplo muestra el formato del objeto PasswordGenerationPolicy.
{
"length" : 32,
"include_digits" : true,
"include_symbols" : true,
"include_uppercase" : true
}
PasswordGenerationPolicyPatch
El siguiente ejemplo muestra el formato del objeto PasswordGenerationPolicyPatch.
{
"length" : 12,
"include_digits" : true,
"include_symbols" : true,
"include_uppercase" : true
}
PrivateCertificateCryptoKey
El siguiente ejemplo muestra el formato del objeto PrivateCertificateCryptoKey.
{
"type" : "hyper_protect_crypto_services",
"instance_crn" : "crn:v1:bluemix:public:hs-crypto:us-south:a/791f3fb10486421e97aa8512f18b7e65:b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5::",
"pin_iam_credentials_secret_id" : "6ebb80d3-26d1-4e24-81d6-afb0d8e22f54",
"private_keystore_id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5"
}
PublicCertificateRotationObject
El siguiente ejemplo muestra el formato del objeto PublicCertificateRotationObject.
{
"rotate_keys" : true
}
RotationPolicy
El siguiente ejemplo muestra el formato del objeto RotationPolicy.
{
"auto_rotate" : true,
"interval" : 1,
"unit" : "day"
}
SecretActionPrototype
El siguiente ejemplo muestra el formato del objeto SecretActionPrototype.
{
"action_type" : "private_cert_action_revoke_certificate"
}
SecretLockPrototype[]
El siguiente ejemplo muestra el formato del objeto SecretLockPrototype[] .
[ {
"name" : "lock-example-1",
"description" : "lock for consumer 1",
"attributes" : {
"anyKey" : "anyValue"
}
} ]
SecretPrototype
El siguiente ejemplo muestra el formato del objeto SecretPrototype.
{
"custom_metadata" : {
"anyKey" : "anyValue"
},
"description" : "Description of my arbitrary secret.",
"expiration_date" : "2030-10-05T11:49:42Z",
"labels" : [ "dev", "us-south" ],
"name" : "example-arbitrary-secret",
"secret_group_id" : "default",
"secret_type" : "arbitrary",
"payload" : "secret-data",
"version_custom_metadata" : {
"anyKey" : "anyValue"
}
}
SecretTaskError
El siguiente ejemplo muestra el formato del objeto SecretTaskError.
{
"code" : "exampleString",
"description" : "Failed to create credentials"
}
SecretTaskPrototype
El siguiente ejemplo muestra el formato del objeto SecretTaskPrototype.
{
"status" : "credentials_created",
"credentials" : {
"id" : "b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5",
"payload" : {
"anyKey" : "anyValue"
}
}
}
SecretVersionActionPrototype
El siguiente ejemplo muestra el formato del objeto SecretVersionActionPrototype.
{
"action_type" : "private_cert_action_revoke_certificate"
}
SecretVersionPrototype
El siguiente ejemplo muestra el formato del objeto SecretVersionPrototype.
{
"payload" : "updated secret credentials",
"custom_metadata" : {
"anyKey" : "anyValue"
},
"version_custom_metadata" : {
"anyKey" : "anyValue"
}
}
ServiceCredentialsSecretSourceService
El siguiente ejemplo muestra el formato del objeto ServiceCredentialsSecretSourceService.
{
"crn" : "exampleString"
}