User

/v1/users/{username}

Используйте эту конечную точку, чтобы получить, удалить или обновить аккаунт пользователя.

Чтение

Получение информации о конкретном аккаунте пользователя.

Пример

Чтобы получить аккаунт пользователя, отправьте запрос GET к конечной точке /users/{username}:

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

В случае успеха ответ будет содержать код статуса HTTP 200 OK и следующие полезные данные:

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

Обновление

Пользователь, имеющий роль ROLE_ADMIN, может менять пароли аккаунтов пользователей, имеющих роли ROLE_ADMIN и ROLE_USER. Любой пользователь может также сменить пароль своего аккаунта. При смене пароля аккаунта маркеры доступа пользователя не аннулируются. В настоящее время роль ROLE_ADMIN есть только у пользователя admin. Остальные пользователи имеют роль ROLE_USER.

Пример

Чтобы сменить пароль аккаунта, укажите маркер Bearer, имя пользователя и новый пароль.

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

В случае успеха пароль будет изменен. При этом возвращается код статуса HTTP 200 OK и следующие полезные данные:

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

Удаление

Если какой-либо аккаунт был взломан или для удаления имеются иные причины, пользователь admin должен удалить его. При этом из системы удаляются все связанные с этим аккаунтом маркеры.

Пример

Чтобы удалить аккаунт пользователя, используйте показанный ниже вызов API. Здесь username — имя пользователя удаляемого аккаунта, а Bearer — маркер, принадлежащий аккаунту admin.

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

В случае успеха аккаунт будет удален. Ответ будет содержать код статуса HTTP 200 OK и следующие полезные данные:

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

Коды ошибок