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 un usuario

PDF

GET /accounts/{account_id}/core/v1/users/{user_id}

Devuelve el recurso API de usuario 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}}

user_id

cadena

ruta

Verdadero

ID de la colección de usuarios a listar

Respuesta

Status: 200, Returns the stored User 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-user"

versión

cadena

Verdadero

Versión del recurso. Los valores definidos son:

  • "1,0"

  • "1,1"

  • "1,2"

id

cadena

Verdadero

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

  • Cumple con el esquema UUIDv4

estado

cadena

Verdadero

Cadena JSON que contiene un valor que indica el estado operativo del usuario. Los valores definidos son:

  • "pending" - La cuenta de usuario está en proceso de creación. El usuario solo puede leer y modificar el recurso de usuario (valor por defecto).

  • Este estado no es válido para un usuario con "authProvider" como "local"

  • "active" - La cuenta de usuario está operativa (el usuario puede iniciar sesión si la configuración de la cuenta "isEnabled" es "true").

  • Este es el valor por defecto para un usuario con "authProvider" como "local"

  • "suspended" - La cuenta de usuario está suspendida (el usuario no puede iniciar sesión independientemente de la configuración de la cuenta "isEnabled").

isEnabled

cadena

Verdadero

Cadena JSON que indica si el usuario tiene permiso para iniciar sesión. Los valores definidos son:

  • "true" - El usuario puede iniciar sesión; valor por defecto al crear.

  • "false" - El usuario no puede iniciar sesión.

authID

cadena

Falso

Cadena JSON que contiene el identificador asociado a un proveedor de identidad externo. El contenido de esta cadena depende del authProvider especificado. Para un usuario con "authProvider" como "local", "authID" se establece con el valor de "email". Para un usuario con "authProvider" como "ldap", "authID" se establece con su Nombre Distinguido (DN) del servidor LDAP.

authProvider

cadena

Falso

Cadena JSON que indica el contexto del identificador idAuth. Los valores definidos son:

  • "cloud-central" - La autenticación de usuario procede del servicio NetApp Cloud Central

  • "local" - La autenticación de usuario procede del almacén local de usuarios/contraseñas

  • "ldap" - La autenticación de usuario proviene de un servidor LDAP externo En Astra Control Center, se requiere que todos los usuarios tengan un valor de "local" o "ldap". Si no se especifica un valor, se elegirá por defecto el valor "local". En Astra Control Service, no se admite "authProvider" como "local" o "ldap". Si no se especifica un valor, se elegirá por defecto "cloud-central".

firstName

cadena

Verdadero

Cadena JSON que contiene un nombre de pila largo especificado por el usuario. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 63

  • Esta cadena se valida internamente para evitar ataques XSS, Unicode, de traspaso de directorios y de inyección SQL

lastName

cadena

Verdadero

Cadena JSON que contiene un apellido largo especificado por el usuario. Los valores definidos son:

  • Longitud mínima: 0

  • Longitud máxima: 63

  • Esta cadena se valida internamente para evitar ataques XSS, Unicode, de traspaso de directorios y de inyección SQL

companyName

cadena

Falso

Cadena JSON que contiene el nombre de la empresa asociada al usuario. Si esta clave no existe, indica que no se ha proporcionado un nombre de empresa. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

  • Esta cadena se valida internamente para evitar ataques XSS, Unicode, de traspaso de directorios y de inyección SQL

correo electrónico

cadena

Verdadero

Cadenas JSON que contienen una dirección de correo electrónico especificada por el usuario.

teléfono

cadena

Falso

Cadena JSON que contiene el número de teléfono del usuario. Si esta clave no existe, indica que no se ha proporcionado un número de teléfono.

postalAddress

"postalAddress"

Falso

Objeto JSON que contiene una colección de campos que especifica una dirección. Si esta clave no existe, indica que no se ha proporcionado una dirección. Si esta clave existe, los seis campos contenidos estarán presentes. Si el usuario no ha proporcionado nada, la cadena estará vacía.

sendWelcomeEmail

cadena

Verdadero

Cadena JSON que indica si se enviará un correo electrónico de bienvenida tras la validación. Si no se especifica al crear, el valor se establecerá en "true" para ACS y en "false" para Astra Control Center. Los valores definidos son:

  • "true" - Se enviará un correo electrónico de bienvenida; valor por defecto al crear

  • "false" - No se enviará un correo electrónico de bienvenida Para un usuario con "authProvider" como "local" o "ldap", este valor se ignora y se establece en "false".

enableTimestamp

cadena

Falso

Cadena JSON que contiene una marca de tiempo con formato ISO-8601 que indica cuándo se habilitó el usuario por última vez. Los valores definidos son:

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

lastActTimestamp

cadena

Falso

Cadena JSON que contiene una marca de tiempo con formato ISO-8601 que indica cuándo se invocó por última vez la API de identidad en nombre de este usuario. (Nota: esto es caro.) 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-user",
  "version": "1.2",
  "id": "5bad8e04-e2fd-5c43-98d7-300580993f49",
  "state": "active",
  "isEnabled": "true",
  "authID": "HteLK3hk28sdbDLKHReB",
  "authProvider": "cloud-central",
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "NetApp, Inc.",
  "email": "jdoe@example.com",
  "phone": "408-555-22222",
  "postalAddress": {
    "addressCountry": "US",
    "addressLocality": "Sunnyvale",
    "addressRegion": "California",
    "postalCode": "94089",
    "streetAddress1": "495 East Java Drive"
  },
  "sendWelcomeEmail": "true",
  "enableTimestamp": "2020-08-05T14:24:54.128427Z",
  "lastActTimestamp": "2020-08-05T14:24:54.128427Z",
  "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

postalAddress

Objeto JSON que contiene una colección de campos que especifica una dirección. Si esta clave no existe, indica que no se ha proporcionado una dirección. Si esta clave existe, los seis campos contenidos estarán presentes. Si el usuario no ha proporcionado nada, la cadena estará vacía.

Nombre Tipo Obligatorio Descripción

addressCountry

cadena

Verdadero

Cadena JSON que contiene el nombre del país o el código de país asociado a la dirección postal, tal como se especifica en ISO 3166 Alpha-2. Los valores definidos son:

  • Longitud mínima: 2

  • Longitud máxima: 2

addressLocality

cadena

Verdadero

Cadena JSON que contiene la localidad (por ejemplo, ciudad) asociada a la dirección postal. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

addressRegion

cadena

Verdadero

Cadena JSON que contiene la región (por ejemplo, estado) asociada a la dirección postal. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

postalCode

cadena

Verdadero

Cadena JSON que contiene el código postal asociado a la dirección postal. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

streetAddress1

cadena

Verdadero

Cadena JSON que contiene la dirección de la calle asociada a la dirección postal. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

streetAddress2

cadena

Falso

Cadena JSON que contiene información auxiliar opcional sobre la dirección, apartado de correos, etc. Los valores definidos son:

  • Longitud mínima: 1

  • Longitud máxima: 63

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