Saltar al contenido
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Usuarios

Llamadas de API para la operación de los objetos Usuarios (Usuarios de Acceso al Sistema).

Base path: /users/


Listar Usuarios

Realiza la consulta de los usuarios registrados en la plataforma Autosky y vinculados a los clientes.

GET /users/

Parámetros de Query (opcionales)

Parámetro
Tipo
Descripción

cli_uuid

string

UUID del cliente para filtrar usuarios específicos

Respuesta

Status: 200 OK

[
    {
        "nome": "João",
        "sobrenome": "Souza",
        "email": "joao.souza@dominio.com",
        "ativo": true,
        "username": "joao.souza",
        "usr_uuid": "3bc705ab-5536-4193-bd5c-2d3e8ffd2e5b",
        "external_ad": false
    }
]

Obtener datos de un usuario

Obtiene los datos de un usuario especificado por su UUID. Además de los campos del listado, también incluye el campo clients.

Parámetros de Path

Parámetro
Obligatorio
Descripción

usr_uuid

Sí

UUID del usuario

Respuesta

Status: 200 OK


Registrar Usuario

Realiza el registro de un nuevo usuario en la plataforma.

  • En caso de que el usuario ya exista, este procedimiento solo lo vinculará al cliente enviado como parámetro.

  • Almacene el UUID de retorno para modificaciones futuras.

  • Si posee un Active Directory específico para el entorno, utilice external_ad: true para configurar la contraseña en el registro.

Cuerpo de la Solicitud

Campo
Tipo
Obligatorio
Descripción

nome

string

Sí

Nombre del usuario

sobrenome

string

No

Apellido del usuario

email

string

Sí

Correo electrónico de inicio de sesión del usuario

ativo

boolean

No

Si el usuario está activo

username

string

No

Nombre del usuario en el AD

password

string

No

Contraseña del usuario

cli_uuid

string

Sí

UUID del cliente en el que se registrará el usuario

description

string

No

Información complementaria del usuario

fullname

string

No

Nombre completo (debe contener al menos dos palabras separadas)

external_ad

boolean

No

true en caso de que posea un Active Directory propio

send_activation_email

boolean

No

Si se debe enviar un correo electrónico de activación al usuario

Ejemplo de Solicitud

Respuesta

Status: 200 OK


Editar Usuario

Realiza la edición de la información del usuario. Solo se podrá modificar cierta información.

Parámetros de Path

Parámetro
Obligatorio
Descripción

usr_uuid

Sí

UUID del usuario

Cuerpo de la Solicitud

Campo
Tipo
Descripción

nome

string

Nombre del usuario

sobrenome

string

Apellido del usuario

ativo

boolean

Si el usuario está activo

password

string

Contraseña del usuario

description

string

Información complementaria

Ejemplo de Solicitud

Respuesta

Status: 200 OK

Devuelve el objeto completo del usuario actualizado, incluyendo el array clients.


Activar / Desactivar Usuario

Activa o desactiva un usuario

Parámetros de Path

Parámetro
Obligatorio
Descripción

usr_uuid

Sí

UUID do usuário

Cuerpo de la Solicitud

Campo
Tipo
Obligatorio
Descripción

ativo

boolean

Sí

true para activar, false para desactivar

send_activation_email

boolean

No

Si se debe enviar un correo electrónico de activación

cli_uuid

string

No

UUID del cliente asociado al envío del correo electrónico

Ejemplo de Solicitud

Respuesta

Status: 200 OK


Cambiar contraseña del usuario

Modifica la contraseña de acceso de un usuario.

La información de la contraseña no se almacena en la base de datos de la plataforma Autosky. Se almacena directamente en el AD de autenticación definido en la plataforma.

Parámetros de Path

Parámetro
Obligatorio
Descripción

usr_uuid

Sí

UUID del usuario

Cuerpo de la Solicitud

Campo
Tipo
Obligatorio
Descripción

password

string

Sí

Nueva contraseña del usuario

Ejemplo de Solicitud

Respuesta

Status: 200 OK


Eliminar Usuario

Este endpoint elimina un usuario o lo desvincula de un cliente específico.

Parámetros de Petición (Body)

A diferencia de las peticiones de eliminación tradicionales, este endpoint acepta y puede requerir un cuerpo (body) en formato application/json.

  • cli_uuid (string): Identificador del cliente del cual desea desvincular al usuario.

    • Obligatorio si el usuario posee vínculo con más de un cliente.

    • Opcional si el usuario está vinculado a un solo cliente.

Ejemplo de Request Body:

Respostas

  • 200 OK - Éxito

El usuario fue eliminado del sistema o desvinculado del cliente con éxito.

  • 200 OK - Cliente no informado (Múltiples Vínculos)

Se retorna cuando el usuario posee vínculos con más de un cliente, pero el cli_uuid no fue enviado en el cuerpo de la petición. (Nota: El estado HTTP retornado es 200 y no un error 4xx). La respuesta traerá la lista de clientes a los cuales pertenece el usuario para que se elija uno.

Ejemplo:

  • 404 Not Found - No Encontrado

El usuario informado no existe o no fue encontrado.

Última actualización

¿Te fue útil?