Skip to main content
Astra Automation
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Recuperar una credencial

PDF

GET /accounts/{account_id}/core/v1/credentials/{credential_id}

Devuelve el recurso de la API de credenciales almacenado en el cuerpo de respuesta JSON.

Parámetros

Nombre Tipo En Obligatorio Descripción

account_id

cadena

ruta

Verdadero

ID del recurso de cuenta que lo contiene

  • ejemplo: {{.Account}}

credential_id

cadena

ruta

Verdadero

ID de la colección de credenciales a listar

Respuesta

Status: 200, Returns the stored Credential API resource in the JSON response body.
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

Tipo de medio del recurso. Los valores definidos son:

  • "application/astra-credential"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

  • "1,0"

  • "1,1"

id

cadena

Verdadero

Identificador único global del recurso. Los valores definidos son:

  • Cumple con el esquema UUIDv4

nombre

cadena

Verdadero

Cadena JSON que contiene un nombre especificado por el usuario. Cuando se crea una credencial para un usuario, el nombre se establecerá con el UUID de ese usuario. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 127

keyType

cadena

Falso

Cadena JSON que contiene un descriptor opcional del tipo de validación de datos especificado por el usuario para el contenido de keyStore. Restricciones de actualización ampliadas:

  • Si un keyType no existe en el recurso y no se especifica en una actualización, el keyType no debe seguir existiendo en el recurso actualizado.

  • Si un keyType no existe en el recurso y se especifica en una actualización, el keyType debe añadirse al recurso y debe realizarse la validación. Si la validación falla, la actualización fallará.

  • Si existe un keyType en el recurso y no se especifica en una actualización, el keyType debe conservarse.

  • Si existe un keyType en el recurso y se especifica en una actualización, y el keyType especificado coincide con el keyType existente, el keyType debe conservarse.

  • Si existe un keyType en el recurso y se especifica en una actualización, y el keyType especificado es diferente del keyType existente, la actualización fallará. Los valores definidos son:

  • "generic" - La credencial es una colección genérica de datos. Esto equivale a no incluir un keyType.

  • La validación ampliada se realiza del siguiente modo:

  • Debe existir una o varias cadenas en el keyStore.

  • Cada cadena en keyStore debe tener un valor codificado en base64.

  • "passwordHash" - La credencial es un hash de contraseña.

  • La validación ampliada se realiza del siguiente modo:

  • El nombre de la credencial debe ser único.

  • El nombre de la credencial debe ser igual a un ID de recurso de usuario válido.

  • El nombre de la credencial no debe alterarse.

  • El recurso de usuario correspondiente debe tener un "authProvider" de "local".

  • Debe existir una cadena "cleartext" dentro de keyStore con un valor que contenga una contraseña en texto claro codificada en base64:

  • El texto claro de la contraseña debe ajustarse a la política de contraseñas de la cuenta.

  • La contraseña se almacena como un hash.

  • Debe existir una cadena "change" dentro de keyStore con un valor que contenga una cadena codificada en base64 "true" o "false".

  • Una credencial del tipo passwordHash solo puede eliminarse si el ID de usuario indicado por el nombre no existe.

  • "apikey" - La credencial es una clave API.

  • La validación ampliada se realiza del siguiente modo:

  • Debe existir una cadena "apikey" dentro de keyStore, con un valor que contenga una cadena arbitraria codificada en base64.

  • "kubeconfig" - la credencial es una kubeconfig.

  • La validación ampliada se realiza del siguiente modo:

  • Debe existir una cadena "base64" dentro de keyStore, con un valor que contenga un archivo kubeconfig JSON codificado en base64.

  • El archivo kubeconfig solo debe describir un único clúster.

  • No pueden existir otros campos dentro de keyStore.

  • "certificado" - la credencial es un certificado codificado PEM

  • La validación ampliada se realiza del siguiente modo:

  • Debe existir una cadena "certificate" dentro de keyStore, con un valor que contenga un certificado PEM codificado en base64.

  • "privkey" - La credencial es una clave privada codificada en PEM.

  • La validación ampliada se realiza del siguiente modo:

  • Debe existir una cadena "privkey" dentro de keyStore, con un valor que contenga una clave privada PEM codificada en base64.

  • "s3" - Indica que las credenciales son para acceso a Simple Storage Service (S3).

  • La validación ampliada se realiza del siguiente modo:

  • Debe existir una cadena ""accessKey"" dentro de keyStore con un valor que contenga una clave de acceso S3 codificada en base64.

  • Debe existir una cadena ""accessSecret"" dentro de keyStore con un valor que contenga un secreto de acceso S3 codificado en base64.

válido

cadena

Verdadero

Cadena JSON que describe si la credencial es válida para su uso. El valor por defecto, si se omite, es "true". Los valores definidos son:

  • "true" - La credencial es apta para su uso.

  • "false" - La credencial no debe utilizarse.

validFromTimestamp

cadena

Falso

Cadena JSON que contiene una marca de tiempo que indica cuándo es válida la credencial. Se utilizan para la rotación de credenciales. Los valores definidos son:

  • Cumple con el esquema de fecha y hora ISO-8601

validUntilTimestamp

cadena

Falso

Cadena JSON que contiene una marca de tiempo que indica cuándo deja de ser válida la credencial. Se utilizan para la rotación de credenciales. Los valores definidos son:

  • Cumple con el esquema de fecha y hora ISO-8601

metadatos

"type_astra_metadatos_update"

Verdadero

Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:

  • Conforme al esquema de metadatos de Astra. Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.
Ejemplo de respuesta 
{
  "type": "application/astra-credential",
  "version": "1.1",
  "id": "58e26f6a-a631-5122-8e0e-7afe306675c0",
  "name": "myCert",
  "valid": "true",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Respuesta

Status: 401, Unauthorized
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso
Ejemplo de respuesta 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Respuesta

Status: 400, Bad request
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso

invalidParams

matriz["invalidParams"]

Falso

Lista de parámetros de consulta no válidos
Ejemplo de respuesta 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Respuesta

Status: 403, Forbidden
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso
Ejemplo de respuesta 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Error

Status: 404, Not found
Nombre Tipo Obligatorio Descripción

tipo

cadena

Verdadero

título

cadena

Verdadero

detalle

cadena

Verdadero

estado

cadena

Verdadero

correlationID

cadena

Falso
Ejemplo de respuesta de error 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definiciones

Ver definiciones

etiqueta_tipo_astra

Nombre Tipo Obligatorio Descripción

nombre

cadena

Verdadero

valor

cadena

Verdadero

type_astra_metadatos_update

Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:

  • Conforme al esquema de metadatos de Astra. Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.

Nombre Tipo Obligatorio Descripción

etiquetas

array["etiqueta_tipo_astra"]

Falso

CreationTimestamp

cadena

Falso

Modificación.Marca de hora

cadena

Falso

CreatedBy

cadena

Falso

modifiedBy

cadena

Falso

invalidParams

Nombre Tipo Obligatorio Descripción

nombre

cadena

Verdadero

Nombre del parámetro de consulta no válido

motivo

cadena

Verdadero

Razón por la que el parámetro de consulta no es válido