Usuario

/v1/users/{username}

Usa este punto de conexión para recuperar, eliminar o actualizar una cuenta de usuario.

Leer

Obtén información sobre una cuenta de usuario específica.

Ejemplo:

Para recuperar una cuenta de usuario, usa una solicitud GET en el punto de conexión /users/{username}:

GET /v1/users/username
Authorization: Bearer your-auth-token

Si la solicitud es satisfactoria, la respuesta es un código de estado HTTP 200 OK y una carga similar a la siguiente:

{
   "users": [{
     "ROLES": "ROLE_ADMIN | ROLE_USER",
     "username": "username"
   }]
}

Actualización

Un usuario con el rol ROLE_ADMIN puede actualizar la contraseña correspondiente a las cuentas de usuario con los roles ROLE_ADMIN y ROLE_USER. Cada usuario también puede actualizar la contraseña de su propia cuenta. Actualizar la contraseña de una cuenta de usuario no invalida los tokens de acceso del usuario. Actualmente, solo el usuario admin tiene el rol ROLE_ADMIN; los demás usuarios tienen el rol ROLE_USER.

Ejemplo:

Para actualizar la contraseña de una cuenta, proporciona el token Bearer junto con el nombre de usuario y la nueva contraseña.

PUT /v1/users/username
Authorization: Bearer your-auth-token
   
{
  "password": "new-password"
}

Si la solicitud es satisfactoria, se actualiza la contraseña correspondiente al nombre de usuario. Se devuelve el código de estado HTTP 200 OK, junto con una carga similar a la siguiente:

{
   "users": [{
      "username": "username"
   }]
}

Eliminación

Si una cuenta se ve vulnerada o si existen otras razones para eliminarla, el admin debe eliminar la cuenta. Después de eliminar una cuenta satisfactoriamente, se eliminan del sistema todos los tokens asociados a esa cuenta.

La cuenta admin no puede eliminarse del sistema.

Ejemplo:

Usa la siguiente llamada a la API para eliminar una cuenta de usuario, donde username es el nombre de la cuenta de usuario que deseas borrar. El token Bearer es el token que pertenece a la cuenta admin.

DELETE /v1/users/username
Authorization: Bearer your-auth-token

Si la solicitud es satisfactoria, la cuenta de usuario se elimina. La respuesta incluye el código de estado HTTP 200 OK y la siguiente carga:

{
   "users": [{
      "username": "username"
   }]
}

Códigos de error

Código de estado HTTPRazón

400

Nombre de usuario no válido, admin

401

No fue posible validar las credenciales

403

No se está usando la cuenta admin

404

La cuenta no existe

500

Razón desconocida