Usuario

/v1/users/{username}

Usa este extremo para recuperar, eliminar o actualizar una cuenta de usuario.

Lectura

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

Ejemplo

Para recuperar una cuenta de usuario, usa una solicitud GET en el extremo /users/{username}:

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

Si se realiza correctamente, la respuesta será un código de estado HTTP 200 OK junto con una carga útil 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 asociada a cuentas de usuario con los roles ROLE_ADMIN y ROLE_USER. Los usuarios individuales también pueden actualizar la contraseña de sus propias cuentas. La actualización de la contraseña de una cuenta de usuario no invalida ningún identificador de acceso asociado al 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 identificador Bearer junto con el nombre de usuario y una contraseña nueva.

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

Si se realiza correctamente, la contraseña asociada al nombre de usuario se actualiza. Se devuelve el código de estado HTTP 200 OK junto con una carga útil similar a la siguiente:

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

Eliminación

Si una cuenta está en riesgo o existen otros motivos para eliminarla, debe eliminarla el usuario admin. Después de eliminar una cuenta correctamente, todos los identificadores asociados a la cuenta se eliminan del sistema.

Ejemplo

Utiliza la llamada a la API siguiente para eliminar una cuenta de usuario, donde username es el nombre de la cuenta de usuario que quieres eliminar. Bearer es el identificador perteneciente a la cuenta admin.

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

Si se realiza correctamente, se elimina la cuenta de usuario. La respuesta incluye el código de estado HTTP 200 OK y la carga útil siguiente:

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

Códigos de error