auth

auth

GET /auth/token/accessors

ID операции: token-list-accessors

Возвращает список аксессоров токенов, с помощью которых затем можно перебрать токены, получить их свойства или отозвать их. Поскольку это может привести к отказу в обслуживании, для этой конечной точки помимо права ’list’ требуется право ‘sudo’.

Требует sudo: да

Параметры

Ответы

200: OK

POST /auth/token/create

ID операции: token-create

Создает новые токены.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/create-orphan

ID операции: token-create-orphan

Создает новые токены-сироты (без родителя).

Параметры тела запроса

Ответы

200: OK

POST /auth/token/create/{role_name}

ID операции: token-create-against-role

Создает новые токены в соответствии с указанной ролью.

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/token/lookup

ID операции: token-look-up-2

Возвращает токен и его свойства.

Ответы

200: OK

POST /auth/token/lookup

ID операции: token-look-up

Возвращает токен и его свойства.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/lookup-accessor

ID операции: token-look-up-accessor

Возвращает свойства токена, связанного с указанным аксессором. Ответ не содержит идентификатор токена.

Параметры тела запроса

Ответы

200: OK

GET /auth/token/lookup-self

ID операции: token-look-up-self

Возвращает токен и его свойства.

Ответы

200: OK

POST /auth/token/lookup-self

ID операции: token-look-up-self2

Возвращает токен и его свойства.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/renew

ID операции: token-renew

Продлевает указанный токен, не давая истечь сроку его действия.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/renew-accessor

ID операции: token-renew-accessor

Продлевает токен, связанный с указанным аксессором. Ответ не содержит идентификатор токена.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/renew-self

ID операции: token-renew-self

Продлевает токен, которым выполнен вызов, не давая истечь сроку его действия.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/revoke

ID операции: token-revoke

Удаляет заданный токен и все его дочерние токены.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/revoke-accessor

ID операции: token-revoke-accessor

Удаляет токен, связанный с аксессором, и все его дочерние токены.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/revoke-orphan

ID операции: token-revoke-orphan

Удаляет токен, а его дочерние токены делает сиротами.

Параметры тела запроса

Ответы

200: OK

POST /auth/token/revoke-self

ID операции: token-revoke-self

Удаляет токен, которым выполнен вызов, и все его дочерние токены.

Ответы

200: OK

GET /auth/token/roles

ID операции: token-list-roles

Возвращает список настроенных ролей.

Параметры

Ответы

200: OK

GET /auth/token/roles/{role_name}

ID операции: token-read-role

Параметры

Ответы

200: OK

POST /auth/token/roles/{role_name}

ID операции: token-write-role

Поддерживается создание: да

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/token/roles/{role_name}

ID операции: token-delete-role

Параметры

Ответы

204: пустое тело

POST /auth/token/tidy

ID операции: token-tidy

Выполняет задачи очистки, которые можно запустить при возникновении определенных ошибок.

Ответы

200: OK

POST /auth/{approle_mount_path}/login

ID операции: app-role-login

Выдает токен на основе предоставленных учетных данных

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{approle_mount_path}/role

ID операции: app-role-list-roles

Возвращает список всех ролей, зарегистрированных в бэкенде.

Параметры

Ответы

200: OK

GET /auth/{approle_mount_path}/role/{role_name}

ID операции: app-role-read-role

Регистрирует роль в бэкенде.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}

ID операции: app-role-write-role

Регистрирует роль в бэкенде.

Поддерживается создание: да

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{approle_mount_path}/role/{role_name}

ID операции: app-role-delete-role

Регистрирует роль в бэкенде.

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/bind-secret-id

ID операции: app-role-read-bind-secret-id

Требовать предъявления secret_id при входе с этой ролью.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/bind-secret-id

ID операции: app-role-write-bind-secret-id

Требовать предъявления secret_id при входе с этой ролью.

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/bind-secret-id

ID операции: app-role-delete-bind-secret-id

Требовать предъявления secret_id при входе с этой ролью.

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/bound-cidr-list

ID операции: app-role-read-bound-cidr-list

Устарело: список CIDR-блоков через запятую; если задан, определяет диапазоны IP-адресов, с которых разрешен вход

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/bound-cidr-list

ID операции: app-role-write-bound-cidr-list

Устарело: список CIDR-блоков через запятую; если задан, определяет диапазоны IP-адресов, с которых разрешен вход

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/bound-cidr-list

ID операции: app-role-delete-bound-cidr-list

Устарело: список CIDR-блоков через запятую; если задан, определяет диапазоны IP-адресов, с которых разрешен вход

Параметры

Ответы

204: No Content

POST /auth/{approle_mount_path}/role/{role_name}/custom-secret-id

ID операции: app-role-write-custom-secret-id

Назначить роли произвольный SecretID.

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{approle_mount_path}/role/{role_name}/local-secret-ids

ID операции: app-role-read-local-secret-ids

Включает локальные для кластера SecretID

Параметры

Ответы

200: OK

GET /auth/{approle_mount_path}/role/{role_name}/period

ID операции: app-role-read-period

Обновляет значение ‘period’ в роли

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/period

ID операции: app-role-write-period

Обновляет значение ‘period’ в роли

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/period

ID операции: app-role-delete-period

Обновляет значение ‘period’ в роли

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/policies

ID операции: app-role-read-policies

Политики роли.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/policies

ID операции: app-role-write-policies

Политики роли.

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/policies

ID операции: app-role-delete-policies

Политики роли.

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/role-id

ID операции: app-role-read-role-id

Возвращает ‘role_id’ роли.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/role-id

ID операции: app-role-write-role-id

Возвращает ‘role_id’ роли.

Параметры

Параметры тела запроса

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/secret-id

ID операции: app-role-list-secret-ids

Сгенерировать SecretID для этой роли.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/secret-id

ID операции: app-role-write-secret-id

Сгенерировать SecretID для этой роли.

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/secret-id-accessor/destroy

ID операции: app-role-destroy-secret-id-by-accessor

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/secret-id-accessor/destroy

ID операции: app-role-destroy-secret-id-by-accessor2

Параметры

Ответы

204: No Content

POST /auth/{approle_mount_path}/role/{role_name}/secret-id-accessor/lookup

ID операции: app-role-look-up-secret-id-by-accessor

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{approle_mount_path}/role/{role_name}/secret-id-bound-cidrs

ID операции: app-role-read-secret-id-bound-cidrs

Список CIDR-блоков через запятую; если задан, определяет диапазоны IP-адресов, с которых разрешен вход

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/secret-id-bound-cidrs

ID операции: app-role-write-secret-id-bound-cidrs

Список CIDR-блоков через запятую; если задан, определяет диапазоны IP-адресов, с которых разрешен вход

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/secret-id-bound-cidrs

ID операции: app-role-delete-secret-id-bound-cidrs

Список CIDR-блоков через запятую; если задан, определяет диапазоны IP-адресов, с которых разрешен вход

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/secret-id-num-uses

ID операции: app-role-read-secret-id-num-uses

Лимит использований SecretID, сгенерированных для этой роли.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/secret-id-num-uses

ID операции: app-role-write-secret-id-num-uses

Лимит использований SecretID, сгенерированных для этой роли.

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/secret-id-num-uses

ID операции: app-role-delete-secret-id-num-uses

Лимит использований SecretID, сгенерированных для этой роли.

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/secret-id-ttl

ID операции: app-role-read-secret-id-ttl

Срок действия в секундах для SecretID, сгенерированных для этой роли.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/secret-id-ttl

ID операции: app-role-write-secret-id-ttl

Срок действия в секундах для SecretID, сгенерированных для этой роли.

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/secret-id-ttl

ID операции: app-role-delete-secret-id-ttl

Срок действия в секундах для SecretID, сгенерированных для этой роли.

Параметры

Ответы

204: No Content

POST /auth/{approle_mount_path}/role/{role_name}/secret-id/destroy

ID операции: app-role-destroy-secret-id

Аннулировать выданный secret_id

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/secret-id/destroy

ID операции: app-role-destroy-secret-id2

Аннулировать выданный secret_id

Параметры

Ответы

204: No Content

POST /auth/{approle_mount_path}/role/{role_name}/secret-id/lookup

ID операции: app-role-look-up-secret-id

Прочитать свойства выданного secret_id

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{approle_mount_path}/role/{role_name}/token-bound-cidrs

ID операции: app-role-read-token-bound-cidrs

Строка через запятую или список CIDR-блоков. Если задан, определяет диапазоны IP-адресов, которым разрешено использовать возвращаемый токен.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/token-bound-cidrs

ID операции: app-role-write-token-bound-cidrs

Строка через запятую или список CIDR-блоков. Если задан, определяет диапазоны IP-адресов, которым разрешено использовать возвращаемый токен.

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/token-bound-cidrs

ID операции: app-role-delete-token-bound-cidrs

Строка через запятую или список CIDR-блоков. Если задан, определяет диапазоны IP-адресов, которым разрешено использовать возвращаемый токен.

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/token-max-ttl

ID операции: app-role-read-token-max-ttl

Максимальное время жизни в секундах для токенов, выданных с помощью SecretID этой роли; по его истечении продлить токены нельзя.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/token-max-ttl

ID операции: app-role-write-token-max-ttl

Максимальное время жизни в секундах для токенов, выданных с помощью SecretID этой роли; по его истечении продлить токены нельзя.

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/token-max-ttl

ID операции: app-role-delete-token-max-ttl

Максимальное время жизни в секундах для токенов, выданных с помощью SecretID этой роли; по его истечении продлить токены нельзя.

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/token-num-uses

ID операции: app-role-read-token-num-uses

Сколько раз можно использовать выданные токены

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/token-num-uses

ID операции: app-role-write-token-num-uses

Сколько раз можно использовать выданные токены

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/token-num-uses

ID операции: app-role-delete-token-num-uses

Сколько раз можно использовать выданные токены

Параметры

Ответы

204: No Content

GET /auth/{approle_mount_path}/role/{role_name}/token-ttl

ID операции: app-role-read-token-ttl

Время жизни в секундах для токена, выданного с помощью SecretID этой роли; до его истечения токен необходимо продлить.

Параметры

Ответы

200: OK

POST /auth/{approle_mount_path}/role/{role_name}/token-ttl

ID операции: app-role-write-token-ttl

Время жизни в секундах для токена, выданного с помощью SecretID этой роли; до его истечения токен необходимо продлить.

Параметры

Параметры тела запроса

Ответы

204: No Content

DELETE /auth/{approle_mount_path}/role/{role_name}/token-ttl

ID операции: app-role-delete-token-ttl

Время жизни в секундах для токена, выданного с помощью SecretID этой роли; до его истечения токен необходимо продлить.

Параметры

Ответы

204: No Content

POST /auth/{approle_mount_path}/tidy/secret-id

ID операции: app-role-tidy-secret-id

Запустить очистку записей SecretID с истекшим сроком действия.

Параметры

Ответы

202: Принято

GET /auth/{jwt_mount_path}/config

ID операции: jwt-read-configuration

Прочитать текущую конфигурацию бэкенда аутентификации JWT.

Параметры

Ответы

200: OK

POST /auth/{jwt_mount_path}/config

ID операции: jwt-configure

Настроить бэкенд аутентификации JWT.

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{jwt_mount_path}/login

ID операции: jwt-login

Аутентификация в Stronghold с помощью токена JWT (или OIDC).

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{jwt_mount_path}/oidc/auth_url

ID операции: jwt-oidc-request-authorization-url

Запросить URL авторизации для запуска входа через OIDC.

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{jwt_mount_path}/oidc/callback

ID операции: jwt-oidc-callback

Конечная точка обратного вызова для завершения входа через OIDC.

Доступен без аутентификации: да

Параметры

Ответы

200: OK

POST /auth/{jwt_mount_path}/oidc/callback

ID операции: jwt-oidc-callback-form-post

Конечная точка обратного вызова для обработки form_post.

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{jwt_mount_path}/role

ID операции: jwt-list-roles

Возвращает список всех ролей, зарегистрированных в бэкенде.

Параметры

Ответы

200: OK

GET /auth/{jwt_mount_path}/role/{name}

ID операции: jwt-read-role

Прочитать существующую роль.

Параметры

Ответы

200: OK

POST /auth/{jwt_mount_path}/role/{name}

ID операции: jwt-write-role

Регистрирует роль в бэкенде.

Поддерживается создание: да

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{jwt_mount_path}/role/{name}

ID операции: jwt-delete-role

Удалить существующую роль.

Параметры

Ответы

204: пустое тело

GET /auth/{kerberos_mount_path}/config

ID операции: kerberos-read-configuration

Настраивает keytab Kerberos и сервисный аккаунт.

Параметры

Ответы

200: OK

POST /auth/{kerberos_mount_path}/config

ID операции: kerberos-configure

Настраивает keytab Kerberos и сервисный аккаунт.

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{kerberos_mount_path}/config/ldap

ID операции: kerberos-read-ldap-configuration

Настроить подключение к LDAP-серверу и его параметры.

Параметры

Ответы

200: OK

POST /auth/{kerberos_mount_path}/config/ldap

ID операции: kerberos-configure-ldap

Настроить подключение к LDAP-серверу и его параметры.

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{kerberos_mount_path}/groups

ID операции: kerberos-list-groups

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

200: OK

GET /auth/{kerberos_mount_path}/groups/{name}

ID операции: kerberos-read-group

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

200: OK

POST /auth/{kerberos_mount_path}/groups/{name}

ID операции: kerberos-write-group

Управление пользователями, которым разрешена аутентификация.

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{kerberos_mount_path}/groups/{name}

ID операции: kerberos-delete-group

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

204: пустое тело

GET /auth/{kerberos_mount_path}/login

ID операции: kerberos-login2

Доступен без аутентификации: да

Параметры

Ответы

200: OK

POST /auth/{kerberos_mount_path}/login

ID операции: kerberos-login

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{kubernetes_mount_path}/config

ID операции: kubernetes-read-auth-configuration

Настраивает открытый ключ JWT и параметры API Kubernetes.

Параметры

Ответы

200: OK

POST /auth/{kubernetes_mount_path}/config

ID операции: kubernetes-configure-auth

Настраивает открытый ключ JWT и параметры API Kubernetes.

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{kubernetes_mount_path}/login

ID операции: kubernetes-login

Аутентифицирует сервисные аккаунты Kubernetes в Stronghold.

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{kubernetes_mount_path}/role

ID операции: kubernetes-list-auth-roles

Возвращает список всех ролей, зарегистрированных в бэкенде.

Параметры

Ответы

200: OK

GET /auth/{kubernetes_mount_path}/role/{name}

ID операции: kubernetes-read-auth-role

Регистрирует роль в бэкенде.

Параметры

Ответы

200: OK

POST /auth/{kubernetes_mount_path}/role/{name}

ID операции: kubernetes-write-auth-role

Регистрирует роль в бэкенде.

Поддерживается создание: да

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{kubernetes_mount_path}/role/{name}

ID операции: kubernetes-delete-auth-role

Регистрирует роль в бэкенде.

Параметры

Ответы

204: пустое тело

GET /auth/{ldap_mount_path}/config

ID операции: ldap-read-auth-configuration

Настроить подключение к LDAP-серверу и его параметры.

Параметры

Ответы

200: OK

POST /auth/{ldap_mount_path}/config

ID операции: ldap-configure-auth

Настроить подключение к LDAP-серверу и его параметры.

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{ldap_mount_path}/groups

ID операции: ldap-list-groups

Управление дополнительными группами для пользователей, которым разрешена аутентификация.

Параметры

Ответы

200: OK

GET /auth/{ldap_mount_path}/groups/{name}

ID операции: ldap-read-group

Управление дополнительными группами для пользователей, которым разрешена аутентификация.

Параметры

Ответы

200: OK

POST /auth/{ldap_mount_path}/groups/{name}

ID операции: ldap-write-group

Управление дополнительными группами для пользователей, которым разрешена аутентификация.

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{ldap_mount_path}/groups/{name}

ID операции: ldap-delete-group

Управление дополнительными группами для пользователей, которым разрешена аутентификация.

Параметры

Ответы

204: пустое тело

POST /auth/{ldap_mount_path}/login/{username}

ID операции: ldap-login

Вход по имени пользователя и паролю.

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{ldap_mount_path}/users

ID операции: ldap-list-users

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

200: OK

GET /auth/{ldap_mount_path}/users/{name}

ID операции: ldap-read-user

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

200: OK

POST /auth/{ldap_mount_path}/users/{name}

ID операции: ldap-write-user

Управление пользователями, которым разрешена аутентификация.

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{ldap_mount_path}/users/{name}

ID операции: ldap-delete-user

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

204: пустое тело

POST /auth/{saml_mount_path}/callback

ID операции: saml-write-callback

Предоставляет Assertion Consumer Service для обработки привязки к провайдеру удостоверений (IdP).

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{saml_mount_path}/config

ID операции: saml-read-config

Прочитать конфигурацию метода аутентификации.

Параметры

Ответы

200: OK

POST /auth/{saml_mount_path}/config

ID операции: saml-write-config

Обновить конфигурацию метода аутентификации.

Поддерживается создание: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{saml_mount_path}/role

ID операции: saml-list-role

Получить список всех ролей.

Параметры

Ответы

200: OK

GET /auth/{saml_mount_path}/role/{name}

ID операции: saml-read-role-name

Прочитать конфигурацию роли.

Параметры

Ответы

200: OK

POST /auth/{saml_mount_path}/role/{name}

ID операции: saml-write-role-name

Обновить конфигурацию роли.

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{saml_mount_path}/role/{name}

ID операции: saml-delete-role-name

Удалить роль.

Параметры

Ответы

204: пустое тело

POST /auth/{saml_mount_path}/sso_service_url

ID операции: saml-write-sso_service_url

Получить URL службы SSO для начала SAML-аутентификации.

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{saml_mount_path}/token

ID операции: saml-write-token

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

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{userpass_mount_path}/login/{username}

ID операции: userpass-login

Вход по имени пользователя и паролю.

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{userpass_mount_path}/login/{username}/change-password

ID операции: userpass-change-password

Изменить собственный пароль, указав текущий.

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

204: OK

GET /auth/{userpass_mount_path}/password-expiry

ID операции: userpass-read-password-expiry

Прочитать действующие настройки срока действия паролей для этой точки монтирования userpass.

Параметры

Ответы

200: OK

GET /auth/{userpass_mount_path}/password-policy/{policy_name}

ID операции: userpass-read-policies-password

Установить, прочитать или удалить политику паролей, применяемую для userpass.

Параметры

Ответы

200: OK

POST /auth/{userpass_mount_path}/password-policy/{policy_name}

ID операции: userpass-write-policies-password

Установить, прочитать или удалить политику паролей, применяемую для userpass.

Поддерживается создание: да

Параметры

Ответы

204: OK

DELETE /auth/{userpass_mount_path}/password-policy/{policy_name}

ID операции: userpass-delete-policies-password

Установить, прочитать или удалить политику паролей, применяемую для userpass.

Параметры

Ответы

204: OK

GET /auth/{userpass_mount_path}/password_policy/{policy_name}

ID операции: userpass-read-policies-password-deprecated

Установить, прочитать или удалить политику паролей, применяемую для userpass.

Параметры

Ответы

200: OK

POST /auth/{userpass_mount_path}/password_policy/{policy_name}

ID операции: userpass-write-policies-password-deprecated

Установить, прочитать или удалить политику паролей, применяемую для userpass.

Поддерживается создание: да

Параметры

Ответы

204: OK

DELETE /auth/{userpass_mount_path}/password_policy/{policy_name}

ID операции: userpass-delete-policies-password-deprecated

Установить, прочитать или удалить политику паролей, применяемую для userpass.

Параметры

Ответы

204: OK

GET /auth/{userpass_mount_path}/users

ID операции: userpass-list-users

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

200: OK

GET /auth/{userpass_mount_path}/users/{username}

ID операции: userpass-read-user

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

200: OK

POST /auth/{userpass_mount_path}/users/{username}

ID операции: userpass-write-user

Управление пользователями, которым разрешена аутентификация.

Поддерживается создание: да

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{userpass_mount_path}/users/{username}

ID операции: userpass-delete-user

Управление пользователями, которым разрешена аутентификация.

Параметры

Ответы

204: пустое тело

POST /auth/{userpass_mount_path}/users/{username}/password

ID операции: userpass-reset-password

Сбросить пароль пользователя.

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{userpass_mount_path}/users/{username}/policies

ID операции: userpass-update-policies

Обновить политики, связанные с именем пользователя.

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{webauthn_mount_path}/config

ID операции: webauthn-read-configuration

Прочитать конфигурацию WebAuthn

Параметры

Ответы

200: OK

POST /auth/{webauthn_mount_path}/config

ID операции: webauthn-write-configuration

Настроить бэкенд WebAuthn

Параметры

Параметры тела запроса

Ответы

204: No Content

POST /auth/{webauthn_mount_path}/login/begin

ID операции: webauthn-begin-login

Начать вход WebAuthn

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{webauthn_mount_path}/login/finish

ID операции: webauthn-finish-login

Завершить вход WebAuthn

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{webauthn_mount_path}/register/begin

ID операции: webauthn-begin-registration

Начать регистрацию WebAuthn

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

POST /auth/{webauthn_mount_path}/register/finish

ID операции: webauthn-finish-registration

Завершить регистрацию WebAuthn

Доступен без аутентификации: да

Параметры

Параметры тела запроса

Ответы

200: OK

GET /auth/{webauthn_mount_path}/user

ID операции: webauthn-list-users

Получить список зарегистрированных пользователей

Параметры

Ответы

200: OK

GET /auth/{webauthn_mount_path}/user/{name}

ID операции: webauthn-read-user

Прочитать данные зарегистрированного пользователя

Параметры

Ответы

200: OK

POST /auth/{webauthn_mount_path}/user/{name}

ID операции: webauthn-write-user

Обновить пользователя

Поддерживается создание: да

Параметры

Параметры тела запроса

Ответы

200: OK

DELETE /auth/{webauthn_mount_path}/user/{name}

ID операции: webauthn-delete-user

Удалить зарегистрированного пользователя

Параметры

Ответы

204: No Content

DELETE /auth/{webauthn_mount_path}/user/{name}/credential/{credential_id}

ID операции: webauthn-delete-credential

Удалить учетные данные пользователя

Параметры

Ответы

204: No Content

POST /auth/{webauthn_mount_path}/user/{name}/generate-code

ID операции: webauthn-generate-registration-code

Сгенерировать новый одноразовый код регистрации для пользователя

Параметры

Ответы

200: OK