`/sys/locked-users`

Конечная точка /sys/locked-users используется для составления списка заблокированных пользователей и разблокировки их в StarVault.

Более подробную информацию о том, как StarVault обрабатывает блокировки, можно найти в обзоре блокировок пользователей.

1. Список заблокированных пользователей

Конечная точка списка возвращает информацию о пользователях, которые в данный момент заблокированы StarVault.

Метод

Путь

GET

/sys/locked-users

1.1. Параметры

mount_accessor (string, optional) — указывает идентификатор записи монтирования аутентификации, к которой принадлежит пользователь. Если метод доступа к монтированию не указан, ответ включает всех заблокированных пользователей.

Пример запроса:

curl \
  --header "X-Vault-Token: ..." \
  --request GET \
  http://127.0.0.1:8200/v1/sys/locked-users

Пример ответа:

{
   "request_id":"26be5ab9-dcac-9237-ec12-269a8ca647d5",
   "lease_id":"",
   "renewable":false,
   "lease_duration":0,
   "data":{
      "by_namespace":[
         {
            "namespace_id":"root",
            "namespace_path":"",
            "counts":2,
            "mount_accessors":[
               {
                  "mount_accessor":"auth_userpass_837f35fc",
                  "counts":2,
                  "alias_identifiers":[
                      {"user1"},
                      {"user2"}
                  ]
               },
            ]
         }
      ],
      "total":2
   },
   "wrap_info":null,
   "warnings":null,
   "auth":null
}

1.2. Пример запроса с указанием точки монтирования

Пример тела запроса:

{
  "mount_accessor": "auth_userpass_af8d1d32"
}

Пример запроса:

curl \
  --header "X-Vault-Token: ..." \
  --data @payload.json \
  --request GET \
  http://127.0.0.1:8200/v1/sys/locked-users

2. Разблокировка пользователя

Конечная точка разблокировки пользователя освобождает заблокированного пользователя с предоставленными параметрами mount_accessor и alias_identifier. Команда разблокировки является идемпотентной. Вызовы к конечной точке выполняются успешно, даже если пользователь, соответствующий предоставленным параметрам mount_accessor и alias_identifier, в настоящее время не заблокирован.

Метод

Путь

POST

/sys/locked-users/:mount_accessor/unlock/:alias-identifier

2.1. Параметры

mount_accessor (string, required) — указывает идентификатор точки монтирования аутентификации, к которой принадлежит пользователь.
alias_identifier (string, required) – имя псевдонима (пользователя). Например, если псевдоним принадлежит бэкенду userpass, имя должно быть допустимым именем пользователя в методе аутентификации userpass. Если псевдоним принадлежит методу аутентификации approle, имя должно быть допустимым RoleID. Если псевдоним принадлежит методу аутентификации LDAP, имя должно быть допустимым именем пользователя.

Пример запроса:

curl \
  --header "X-Vault-Token: ..." \
  --request POST \
  http://127.0.0.1:8200/v1/sys/locked-users/auth_userpass_af8d1d32/unlock/bsmith