auth

GET /auth/token/accessors

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

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

Требует sudo: да

Параметры

ПараметрТипРасположениеОбязательныйОписание
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

POST /auth/token/create

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

Создает новый токен. Метод используется для создания новых токенов.

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

ПараметрТипОбязательныйОписание
display_namestringнетИмя, которое нужно связать с этим токеном
entity_aliasstringнетНазвание псевдонима сущности, который нужно связать с этим токеном
explicit_max_ttlstringнетЯвный максимальный TTL этого токена
idstringнетЗначение для токена
leasestringнет⚠️ Устарело. Предпочтительно использовать ’ttl'.
metaobjectнетПроизвольные метаданные ключ=значение, которые нужно связать с токеном
no_default_policybooleanнетНе включать политику по умолчанию для этого токена
no_parentbooleanнетСоздает токен без родителя
num_usesintegerнетМаксимальное количество использований этого токена
periodstringнетПериод обновления
policiesarrayнетСписок политик для токена
renewableboolean (default: True)нетПозволяет обновлять токен по истечении его начального TTL до максимального TTL системы/монтирования
ttlstringнетВремя жизни этого токена
typestringнетТип токена

Ответы

200: OK

POST /auth/token/create-orphan

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

Создает новый токен. Метод используется для создания новых токенов-сирот.

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

ПараметрТипОбязательныйОписание
display_namestringнетИмя, которое нужно связать с этим токеном
entity_aliasstringнетНазвание псевдонима сущности, который нужно связать с этим токеном
explicit_max_ttlstringнетЯвный максимальный TTL этого токена
idstringнетЗначение для токена
leasestringнет⚠️ Устарело. Предпочтительно использовать ’ttl'.
metaobjectнетПроизвольные метаданные ключ=значение, которые нужно связать с токеном
no_default_policybooleanнетНе включать политику по умолчанию для этого токена
no_parentbooleanнетСоздает токен без родителя
num_usesintegerнетМаксимальное количество использований этого токена
periodstringнетПериод обновления
policiesarrayнетСписок политик для токена
renewableboolean (default: True)нетПозволяет обновлять токен по истечении его начального TTL до максимального TTL системы/монтирования
ttlstringнетВремя жизни этого токена
typestringнетТип токена

Ответы

200: OK

POST /auth/token/create/{role_name}

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

Создает новый токен. Метод используется для создания новых токенов, соответствующих заданной роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли

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

ПараметрТипОбязательныйОписание
display_namestringнетИмя, которое нужно связать с этим токеном
entity_aliasstringнетНазвание псевдонима сущности, который нужно связать с этим токеном
explicit_max_ttlstringнетЯвный максимальный TTL этого токена
idstringнетЗначение для токена
leasestringнет⚠️ Устарело. Предпочтительно использовать ’ttl'.
metaobjectнетПроизвольные метаданные ключ=значение, которые нужно связать с токеном
no_default_policybooleanнетНе включать политику по умолчанию для этого токена
no_parentbooleanнетСоздает токен без родителя
num_usesintegerнетМаксимальное количество использований этого токена
periodstringнетПериод обновления
policiesarrayнетСписок политик для токена
renewableboolean (default: True)нетПозволяет обновлять токен по истечении его начального TTL до максимального TTL системы/монтирования
ttlstringнетВремя жизни этого токена
typestringнетТип токена

Ответы

200: OK

GET /auth/token/lookup

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

Отображает токен и его свойства.

Ответы

200: OK

POST /auth/token/lookup

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

Отображает токен и его свойства.

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

ПараметрТипОбязательныйОписание
tokenstringнетТокен для поиска (тело POST-запроса)

Ответы

200: OK

POST /auth/token/lookup-accessor

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

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

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

ПараметрТипОбязательныйОписание
accessorstringнетАксессор токена для поиска (тело запроса)

Ответы

200: OK

GET /auth/token/lookup-self

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

Отображает токен и его свойства.

Ответы

200: OK

POST /auth/token/lookup-self

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

Отображает токен и его свойства.

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

ПараметрТипОбязательныйОписание
tokenstringнетТокен для поиска (не используется, устанавливать не нужно)

Ответы

200: OK

POST /auth/token/renew

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

Обновляет заданный токен и предотвращает истечение срока его действия.

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

ПараметрТипОбязательныйОписание
incrementinteger (default: 0)нетЖелаемый интервал в секундах до истечения срока действия токена
tokenstringнетТокен для обновления (тело запроса)

Ответы

200: OK

POST /auth/token/renew-accessor

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

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

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

ПараметрТипОбязательныйОписание
accessorstringнетАксессор токена, который нужно обновить (тело запроса)
incrementinteger (default: 0)нетЖелаемый интервал в секундах до истечения срока действия токена

Ответы

200: OK

POST /auth/token/renew-self

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

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

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

ПараметрТипОбязательныйОписание
incrementinteger (default: 0)нетЖелаемый интервал в секундах до истечения срока действия токена
tokenstringнетТокен для обновления (не используется, устанавливать не нужно)

Ответы

200: OK

POST /auth/token/revoke

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

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

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

ПараметрТипОбязательныйОписание
tokenstringнетТокен для отзыва (тело запроса)

Ответы

200: OK

POST /auth/token/revoke-accessor

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

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

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

ПараметрТипОбязательныйОписание
accessorstringнетАксессор токена (тело запроса)

Ответы

200: OK

POST /auth/token/revoke-orphan

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

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

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

ПараметрТипОбязательныйОписание
tokenstringнетТокен для отзыва (тело запроса)

Ответы

200: OK

POST /auth/token/revoke-self

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

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

Ответы

200: OK

GET /auth/token/roles

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

Получает настроенные роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

GET /auth/token/roles/{role_name}

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли

Ответы

200: OK

POST /auth/token/roles/{role_name}

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли

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

ПараметрТипОбязательныйОписание
allowed_entity_aliasesarrayнетСтроковый или JSON-список разрешенных псевдонимов сущностей. Если установлено, указывает псевдонимы сущностей, которые разрешено использовать при генерации токенов. Это поле поддерживает globbing.
allowed_policiesarrayнетЕсли этот параметр установлен, токены могут быть созданы с любым подмножеством политик из этого списка, а не с обычной семантикой, когда токены являются подмножеством политик вызывающего токена. Параметр представляет собой строку имен политик, разделенную запятыми.
allowed_policies_globarrayнетЕсли этот параметр установлен, токены могут быть созданы с любым подмножеством политик в этом списке, а не с обычной семантикой, когда токены являются подмножеством политик вызывающего токена. Параметр представляет собой разделенную запятыми строку глобусов имен политик.
bound_cidrsarrayнет⚠️ Устарело. Предпочтительно использовать ’token_bound_cidrs'.
disallowed_policiesarrayнетЕсли установлено, для успешного создания токена с помощью этой роли потребуется, чтобы не было запрошено ни одной политики из данного списка. Параметр представляет собой строку имен политик, разделенных запятыми.
disallowed_policies_globarrayнетЕсли этот параметр установлен, то для успешного создания токена с помощью этой роли необходимо, чтобы ни одна из запрашиваемых политик не совпадала ни с одной из политик в этом списке. Параметр представляет собой разделенную запятыми строку глобусов имен политик.
explicit_max_ttlintegerнет⚠️ Устарело. Предпочтительно использовать ’token_explicit_max_ttl'.
orphanbooleanнетЕсли true, то токены, созданные с помощью этой роли, будут сиротскими (не будут иметь родителя).
path_suffixstringнетЕсли установлено, то токены, созданные с помощью этой роли, будут содержать указанный суффикс в качестве части своего пути. Это может быть использовано для помощи в использовании конечной точки ‘revoke-prefix’ в дальнейшем. Указанный суффикс должен соответствовать регулярному выражению.\w[\w-.]+\w
periodintegerнет⚠️ Устарело. Предпочтительно использовать ’token_period’.
renewableboolean (default: True)нетТокены, созданные с помощью этой роли, будут возобновляться или нет в соответствии с этим значением. По умолчанию значение равно “true”.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_explicit_max_ttlintegerнетЕсли установлено, то токены, созданные с помощью этой роли, будут иметь явный максимальный TTL. Во время обновления текущие максимальные значения TTL роли и монтирования не проверяются на изменения, и любые обновления этих значений не повлияют на обновляемый токен.
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).
token_typestring (default: default-service)нетТип генерируемого токена, сервисный или пакетный

Ответы

200: OK

DELETE /auth/token/roles/{role_name}

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли

Ответы

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

POST /auth/token/tidy

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

Запускает задачи по очистке по определенным условиям.

Ответы

200: OK

POST /auth/{approle_mount_path}/login

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
role_idstringнетУникальный идентификатор роли. Обязательно должен быть предоставлен, если установлено ограничение ‘bind_secret_id’.
secret_idstring (default: )нетSecretID принадлежит роли App

Ответы

200: OK

GET /auth/{approle_mount_path}/role

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

Отображает все роли, зарегистрированные в бэкенде.

Параметры

ПараметрТипРасположениеОбязательныйОписание
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

ПараметрТипОбязательныйОписание
keysarrayнет

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
bind_secret_idbooleanнетУстановите обязательное предоставление секретного ID при входе с использованием этой роли.
local_secret_idsbooleanнетЕсли установлено значение true, секретные идентификаторы, созданные с использованием этой роли, будут локальными для кластера. Это можно установить только во время создания роли, и после установки изменить это значение невозможно.
periodintegerнет⚠️ Устарело. Предпочтительно использовать “token_period”. Если указаны и “token_period”, то будет использоваться только “token_period”.
policiesarrayнет⚠️ Устарело. Предпочтительно использовать “token_policies”. Если указаны и “token_policies”, то будет использоваться только “token_policies”.
secret_id_bound_cidrsarrayнетСтрока или список блоков CIDR, разделенных запятыми. Если установлено, указывает блоки IP-адресов, которые могут выполнять операцию входа в систему.
secret_id_num_usesintegerнетКоличество раз, которое секретный идентификатор может получить доступ к роли, после чего секретный идентификатор истечет.
secret_id_ttlintegerнетПродолжительность в секундах после которой выданный секретный ID истекает.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_explicit_max_ttlintegerнетЕсли установлено, то токены, созданные с помощью этой роли, будут иметь явный максимальный TTL. Во время обновления текущие максимальные значения TTL роли и монтирования не проверяются на изменения, и любые обновления этих значений не повлияют на обновляемый токен.
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.
token_periodintegerнетЕсли установлено, токены, созданные с помощью этой роли, не будут иметь максимального срока действия; вместо этого их срок продления будет зафиксирован на этом значении.
token_policiesarrayнетСписок политик, разделенный запятыми
token_ttlintegerнетНачальный ttl генерируемого токена
token_typestring (default: default-service)нетТип генерируемого токена, сервисный или пакетный

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

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
bind_secret_idboolean (default: True)нетВвести secret_id, который должен быть представлен при входе в систему с использованием этой роли. По умолчанию имеет значение ’true'.
bound_cidr_listarrayнет⚠️ Устарело. Предпочтительно использовать “secret_id_bound_cidrs”.
local_secret_idsbooleanнетЕсли установлено, секретные идентификаторы, созданные с помощью этой роли, будут локальными для кластера. Этот параметр может быть задан только при создании роли, и после установки его нельзя сбросить.
periodintegerнет⚠️ Устарело. Предпочтительно использовать “token_period”. Если указаны и “token_period”, то будет использоваться только “token_period”.
policiesarrayнет⚠️ Устарело. Предпочтительно использовать “token_policies”. Если указаны и “token_policies”, то будет использоваться только “token_policies”.
role_idstringнетИдентификатор роли. По умолчанию это UUID.
secret_id_bound_cidrsarrayнетСтрока или список блоков CIDR, разделенных запятыми. Если установлено, указывает блоки IP-адресов, которые могут выполнять операцию входа в систему.
secret_id_num_usesintegerнетКоличество раз, которое SecretID может получить доступ к роли, после чего SecretID истекает. По умолчанию равно 0, что означает неограниченное использование Secret_id.
secret_id_ttlintegerнетПродолжительность в секундах, по истечении которой выданный SecretID должен истечь. По умолчанию равно 0, что означает отсутствие истечения срока действия.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_explicit_max_ttlintegerнетЕсли установлено, то токены, созданные с помощью этой роли, будут иметь явный максимальный TTL. Во время обновления текущие максимальные значения TTL роли и монтирования не проверяются на изменения, и любые обновления этих значений не повлияют на обновляемый токен.
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).
token_policiesarrayнетСписок политик, разделенный запятыми
token_ttlintegerнетНачальный ttl генерируемого токена
token_typestring (default: default-service)нетТип генерируемого токена, сервисный или пакетный

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Указывает secret_id, который должен быть представлен при входе в систему с использованием этой роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
bind_secret_idbooleanнетВвести secret_id, который должен быть представлен при входе в систему с использованием этой роли. По умолчанию имеет значение ’true'.

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

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

Указывает secret_id, который должен быть представлен при входе в систему с использованием этой роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
bind_secret_idboolean (default: True)нетУказывает 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, который должен быть представлен при входе в систему с использованием этой роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Устарело: Список блоков CIDR, разделенных запятыми, если установлен указывает блоки IP-адресов, которые могут выполнять операцию входа

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
bound_cidr_listarrayнет⚠️ Устарело. Утратил актуальность: Предпочтительно использовать “secret_id_bound_cidrs”. Строка или список блоков CIDR, разделенных запятыми. Если задано, указывает блоки IP-адресов, которые могут выполнять операцию входа в систему.

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

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

Устарело: Список блоков CIDR, разделенных запятыми, если установлен указывает блоки IP-адресов, которые могут выполнять операцию входа

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
bound_cidr_listarrayнетУтратил актуальность: Предпочтительно использовать “secret_id_bound_cidrs”. Строка или список блоков 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-адресов, которые могут выполнять операцию входа

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Назначает SecretID на выбор для этой роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
cidr_listarrayнетРазделенная запятыми строка или список блоков CIDR, обеспечивающих использование секретных идентификаторов из определенного набора IP-адресов. Если для роли задан ‘bound_cidr_list’, то список CIDR-блоков, перечисленных здесь, должен быть подмножеством CIDR-блоков, перечисленных для роли.
metadatastringнетМетаданные, которые должны быть привязаны к SecretID. Это должна быть строка в формате JSON, содержащая метаданные в парах ключ-значение.
num_usesintegerнетКоличество раз, которое может быть использован данный SecretID, после чего срок действия SecretID истекает. Переопределяет опцию роли secret_id_num_uses, если она задана. Не может быть больше, чем secret_id_num_uses роли.
secret_idstringнетСекретный идентификатор, который будет привязан к роли.
token_bound_cidrsarrayнетСтрока или список блоков CIDR, разделенных запятыми. Если задано, указывает блоки IP-адресов, которые могут использовать возвращенный токен. Должно быть подмножеством CIDR-блоков токена, перечисленных в роли, если таковые имеются.
ttlintegerнетПродолжительность в секундах, после которой истекает срок действия данного SecretID. Переопределяет опцию роли secret_id_ttl, если она задана. Не может быть больше, чем secret_id_ttl роли.

Ответы

200: OK

ПараметрТипОбязательныйОписание
secret_idstringнетСекретный идентификатор, прикрепленный к роли.
secret_id_accessorstringнетИндентефикатор секретного ID
secret_id_num_usesintegerнетКоличество раз, которое секретный идентификатор может получить доступ к роли, после чего секретный идентификатор истечет.
secret_id_ttlintegerнетПродолжительность в секундах после которой выданный секретный ID истекает.

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

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

Позволяет создавать локальные секретные идентификаторы кластера

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
local_secret_idsbooleanнетЕсли установлено значение true, секретные идентификаторы, созданные с использованием этой роли, будут локальными для кластера. Это можно установить только во время создания роли, и после установки изменить это значение невозможно.

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
periodintegerнет⚠️ Устарело. Предпочтительно использовать “token_period”. Если указаны и “token_period”, то будет использоваться только “token_period”.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
periodintegerнет⚠️ Устарело. Предпочтительно использовать “token_period”. Если указаны и “token_period”, то будет использоваться только “token_period”.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Назначает политику роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
policiesarrayнет⚠️ Устарело. Предпочтительно использовать “token_policies”. Если указаны и “token_policies”, то будет использоваться только “token_policies”.
token_policiesarrayнетСписок политик, разделенный запятыми

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

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

Назначает политику роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
policiesarrayнет⚠️ Устарело. Предпочтительно использовать “token_policies”. Если указаны и “token_policies”, то будет использоваться только “token_policies”.
token_policiesarrayнетСписок политик, разделенный запятыми

Ответы

204: No Content

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

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

Назначает политику роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
role_idstringнетИдентификатор роли. По умолчанию это UUID.

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
role_idstringнетИдентификатор роли. По умолчанию это UUID.

Ответы

204: No Content

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

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

Управляет SecretID для этой роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

ПараметрТипОбязательныйОписание
keysarrayнет

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

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

Управляет SecretID для этой роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
cidr_listarrayнетРазделенная запятыми строка или список блоков CIDR, обеспечивающих использование секретных идентификаторов из определенного набора IP-адресов. Если для роли задан ‘bound_cidr_list’, то список CIDR-блоков, перечисленных здесь, должен быть подмножеством CIDR-блоков, перечисленных для роли.
metadatastringнетМетаданные, которые должны быть привязаны к SecretID. Это должна быть строка в формате JSON, содержащая метаданные в парах ключ-значение.
num_usesintegerнетКоличество раз, которое может быть использован данный SecretID, после чего срок действия SecretID истекает. Переопределяет опцию роли secret_id_num_uses, если она задана. Не может быть больше, чем secret_id_num_uses роли.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
ttlintegerнетПродолжительность в секундах, после которой истекает срок действия данного SecretID. Переопределяет опцию роли secret_id_ttl, если она задана. Не может быть больше, чем secret_id_ttl роли.

Ответы

200: OK

ПараметрТипОбязательныйОписание
secret_idstringнетСекретный идентификатор, прикрепленный к роли.
secret_id_accessorstringнетИндентефикатор секретного ID
secret_id_num_usesintegerнетКоличество раз, которое секретный идентификатор может получить доступ к роли, после чего секретный идентификатор истечет.
secret_id_ttlintegerнетПродолжительность в секундах после которой выданный секретный ID истекает.

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
secret_id_accessorstringнетАксессор SecretID

Ответы

204: No Content

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
secret_id_accessorstringнетАксессор SecretID

Ответы

200: OK

ПараметрТипОбязательныйОписание
cidr_listarrayнетОтображает список блоков CIDR, требующих использования секретных ID из определенного набора IP-адресов. Если ‘bound_cidr_list’ установлен на роли, то список блоков CIDR, указанных здесь, должен быть подмножеством блоков CIDR, указанных на роли.
creation_timestringнет
expiration_timestringнет
last_updated_timestringнет
metadataobjectнет
secret_id_accessorstringнетИндентефикатор секретного ID
secret_id_num_usesintegerнетКоличество раз, которое секретный идентификатор может получить доступ к роли, после чего секретный идентификатор истечет.
secret_id_ttlintegerнетПродолжительность в секундах после которой выданный секретный ID истекает.
token_bound_cidrsarrayнетОтображает список блоков CIDR. Если установлен, указывает блоки IP-адресов, которые могут использовать возвращаемый токен. Должен быть подмножеством блоков CIDR токена, указанных на роли, если таковые имеются.

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

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

Список блоков CIDR, разделенных запятыми, если установлен, указывает блоки IP-адресов, которые могут выполнять операцию входа

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
secret_id_bound_cidrsarrayнетСтрока или список блоков CIDR, разделенных запятыми. Если установлено, указывает блоки IP-адресов, которые могут выполнять операцию входа в систему.

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

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

Список блоков CIDR, разделенных запятыми, если установлен, указывает блоки IP-адресов, которые могут выполнять операцию входа

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
secret_id_bound_cidrsarrayнетСтрока или список блоков 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-адресов, которые могут выполнять операцию входа

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
secret_id_num_usesintegerнетКоличество раз, которое секретный идентификатор может получить доступ к роли, после чего секретный идентификатор истечет. По умолчанию 0 означает, что секретный идентификатор используется неограниченно.

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
secret_id_num_usesintegerнетУправляет количеством раз, когда секретный идентификатор может получить доступ к роли, после чего срок действия секретного идентификатора истекает.

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Управляет продолжительностью в секундах SecretID, сгенерированного для роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
secret_id_ttlintegerнетПродолжительность в секундах после которой выданный секретный ID должен истечь. По умолчанию 0 означает отсутствие срока действия.

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

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

Управляет продолжительностью в секундах SecretID, сгенерированного для роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
secret_id_ttlintegerнетПродолжительность в секундах, по истечении которой выданный SecretID должен истечь. По умолчанию равно 0, что означает отсутствие истечения срока действия.

Ответы

204: No Content

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

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

Управляет продолжительностью в секундах SecretID, сгенерированного для роли.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Управляет аннулированием выданного secret_id

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
secret_idstringнетСекретный идентификатор, прикрепленный к роли.

Ответы

204: No Content

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

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

Управляет аннулированием выданного secret_id

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Чтение свойств выданного secret_id

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
secret_idstringнетСекретный идентификатор, прикрепленный к роли.

Ответы

200: OK

ПараметрТипОбязательныйОписание
cidr_listarrayнетОтображает список блоков CIDR, требующих использования секретных ID из определенного набора IP-адресов. Если ‘bound_cidr_list’ установлен на роли, то список блоков CIDR, указанных здесь, должен быть подмножеством блоков CIDR, указанных на роли.
creation_timestringнет
expiration_timestringнет
last_updated_timestringнет
metadataobjectнет
secret_id_accessorstringнетИндентефикатор секретного ID
secret_id_num_usesintegerнетКоличество раз, которое секретный идентификатор может получить доступ к роли, после чего секретный идентификатор истечет.
secret_id_ttlintegerнетПродолжительность в секундах после которой выданный секретный ID истекает.
token_bound_cidrsarrayнетОтображает список блоков CIDR. Если установлен, указывает блоки IP-адресов, которые могут использовать возвращаемый токен. Должен быть подмножеством блоков CIDR токена, указанных на роли, если таковые имеются.

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
token_bound_cidrsarrayнетСтрока или список блоков CIDR, разделенных запятыми. Если задано, указывает блоки IP-адресов, которые могут использовать возвращенный токен. Должно быть подмножеством CIDR-блоков токена, перечисленных в роли, если таковые имеются.

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков 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-адресов, которые могут использовать возвращаемый токен.

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

ПараметрТипОбязательныйОписание
token_ttlintegerнетНачальный ttl генерируемого токена

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
token_ttlintegerнетНачальный ttl генерируемого токена

Ответы

204: No Content

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
role_namestringpathдаНазвание роли. Должно быть меньше 4096 байт.
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

204: No Content

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

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

Инициировать очистку истекших записей SecretID.

Параметры

ПараметрТипРасположениеОбязательныйОписание
approle_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

202: Принято

GET /auth/{jwt_mount_path}/config

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

POST /auth/{jwt_mount_path}/config

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
bound_issuerstringнетЗначение, с которым следует сопоставить утверждение ‘iss’ в JWT. Необязательно.
default_rolestringнетРоль по умолчанию, используемая, если при входе в систему не указана ни одна из ролей. Если значение не задано, при входе в систему требуется указать роль.
jwks_ca_pemstringнетСертификат ЦС или цепочка сертификатов в формате PEM для проверки соединений с URL JWKS. Если значение не задано, используются системные сертификаты.
jwks_pairsarrayнетНабор пар JWKS Url и сертификата ЦС (или цепочки сертификатов). Сертификаты ЦС должны быть в формате PEM. Не может быть использован с “jwks_url” или “jwks_ca_pem”.
jwks_urlstringнетURL-адрес JWKS для аутентификации подписей. Не может использоваться с “oidc_discovery_url” или “jwt_validation_pubkeys”.
jwt_supported_algsarrayнетСписок поддерживаемых алгоритмов подписи. По умолчанию используется RS256.
jwt_validation_pubkeysarrayнетСписок открытых ключей в кодировке PEM для локальной аутентификации подписей. Не может использоваться с “jwks_url” или “oidc_discovery_url”.
namespace_in_statebooleanнетПередавать пространство имен в параметре состояния OIDC, а не как отдельный параметр запроса. При этой настройке разрешенные URL-адреса перенаправления в Vault и на стороне провайдера не должны содержать параметр запроса пространства имен. Это означает, что на стороне провайдера необходимо поддерживать только одну запись URL перенаправления для всех пространств имен хранилища, которые будут проходить аутентификацию. По умолчанию имеет значение true для новых конфигураций.
oidc_client_idstringнетИдентификатор клиента OAuth, настроенный провайдером OIDC.
oidc_client_secretstringнетСекрет клиента OAuth, настроенный провайдером OIDC.
oidc_discovery_ca_pemstringнетСертификат ЦС или цепочка сертификатов в формате PEM, используемые для проверки соединений с URL-адресом OIDC Discovery. Если значение не задано, используются системные сертификаты.
oidc_discovery_urlstringнетURL-адрес OIDC Discovery, без компонента .well-known (базовый путь). Не может использоваться с “jwks_url” или “jwt_validation_pubkeys”.
oidc_response_modestringнетРежим ответа, который будет использоваться в запросе OAuth2. Допустимые значения: ‘query’ и ‘form_post’.
oidc_response_typesarrayнетТипы ответов для запроса. Допустимые значения: ‘code’ и ‘id_token’. По умолчанию используется значение ‘code’.
provider_configobjectнетКонфигурация для конкретного поставщика. Необязательно.
unsupported_critical_cert_extensionsarrayнетСписок ASN1 OID расширений сертификата с пометкой Critical, которые не поддерживаются Vault и должны быть проигнорированы. Эта опция нужна очень редко, только в специализированных средах PKI.

Ответы

200: OK

POST /auth/{jwt_mount_path}/login

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

Аутентифицирует в Vault с использованием JWT (или OIDC) токена.

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
distributed_claim_access_tokenstringнетНеобязательный токен, используемый для получения членства в группах, указанных в распределенном источнике утверждений в jwt. Поддерживается только для Azure/Entra ID
jwtstringнетПодписанный JWT для проверки.
rolestringнетРоль, под которой нужно войти в систему.

Ответы

200: OK

POST /auth/{jwt_mount_path}/oidc/auth_url

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
client_noncestringнетНеобязательный нонс, предоставленный клиентом, который должен совпадать во время обратного вызова, если он присутствует.
redirect_uristringнетOAuth redirect_uri для использования в URL авторизации.
rolestringнетРоль для выдачи URL-адреса авторизации OIDC.

Ответы

200: OK

GET /auth/{jwt_mount_path}/oidc/callback

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
client_noncestringqueryнет
codestringqueryнет
statestringqueryнет
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

POST /auth/{jwt_mount_path}/oidc/callback

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

Метод обратного вызова для обработки form_posts.

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
client_noncestringqueryнет
codestringqueryнет
statestringqueryнет
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
id_tokenstringнет

Ответы

200: OK

GET /auth/{jwt_mount_path}/role

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

Отображает все роли, зарегистрированные в бэкенде.

Параметры

ПараметрТипРасположениеОбязательныйОписание
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание роли.
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

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

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание роли.
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
allowed_redirect_urisarrayнетСписок допустимых значений для redirect_uri, разделенный запятыми
bound_audiencesarrayнетСписок утверждений ‘aud’, действительных для входа в систему, разделенный запятыми; достаточно любого совпадения
bound_cidrsarrayнет⚠️ Устарело. Предпочтительно использовать “token_bound_cidrs”. Если указаны и “token_bound_cidrs”, то будет использоваться только “token_bound_cidrs”.
bound_claimsobjectнетСписок утверждений и соответствующих значений, которые должны совпадать для входа в систему
bound_claims_typestring (default: string)нетКак интерпретировать значения в карте утверждений/значений (которые должны совпадать для входа в систему): допустимые значения - ‘string’ или ‘glob’
bound_subjectstringнетУтверждение “sub”, действительное для входа в систему. Необязательно.
claim_mappingsobjectнетСопоставление утверждений (ключ), которые будут скопированы в поле метаданных (значение)
clock_skew_leewayinteger (default: 60000000000)нетПродолжительность в секундах свободы действий при проверке всех заявлений для учета перекоса часов. По умолчанию равна 60 (1 минута), если установлено значение 0, и может быть отключена, если установлено значение -1.
expiration_leewayinteger (default: 150)нетПродолжительность в секундах свободы действий при проверке истечения срока действия токена для учета перекоса часов. По умолчанию равна 150 (2,5 минуты), если установлено значение 0, и может быть отключена, если установлено значение -1.
groups_claimstringнетУтверждение, используемое для имен псевдонимов групп идентификации
max_ageintegerнетУказывает допустимое время в секундах, прошедшее с момента последней активной аутентификации пользователя.
max_ttlintegerнет⚠️ Устарело. Предпочтительно использовать “token_max_ttl”. Если указаны и “token_max_ttl”, то будет использоваться только “token_max_ttl”.
not_before_leewayinteger (default: 150)нетДлительность в секундах свободы действий при проверке значений токена “не раньше” для учета перекоса часов. По умолчанию равна 150 (2,5 минуты), если установлено значение 0, и может быть отключена, если установлено значение -1.
num_usesintegerнет⚠️ Устарело. Предпочтительно использовать “token_num_uses”. Если указаны и “token_num_uses”, то будет использоваться только “token_num_uses”.
oidc_scopesarrayнетСписок областей OIDC, разделенный запятыми
periodintegerнет⚠️ Устарело. Предпочтительно использовать “token_period”. Если указаны и “token_period”, то будет использоваться только “token_period”.
policiesarrayнет⚠️ Устарело. Предпочтительно использовать “token_policies”. Если указаны и “token_policies”, то будет использоваться только “token_policies”.
role_typestringнетТип роли, либо ‘jwt’, либо ‘oidc’.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_explicit_max_ttlintegerнетЕсли установлено, то токены, созданные с помощью этой роли, будут иметь явный максимальный TTL. Во время обновления текущие максимальные значения TTL роли и монтирования не проверяются на изменения, и любые обновления этих значений не повлияют на обновляемый токен.
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).
token_policiesarrayнетСписок политик, разделенный запятыми
token_ttlintegerнетНачальный ttl генерируемого токена
token_typestring (default: default-service)нетТип генерируемого токена, сервисный или пакетный
ttlintegerнет⚠️ Устарело. Предпочтительно использовать “token_ttl”. Если указаны и “token_ttl”, и “token_ttl”, будет использоваться только “token_ttl”.
user_claimstringнетУтверждение, используемое для имени псевдонима объекта идентификации
user_claim_json_pointerbooleanнетЕсли значение user_claim равно true, то для ссылок на формулы будет использоваться синтаксис указателей JSON.
verbose_oidc_loggingbooleanнетВедите журнал полученных токенов и утверждений OIDC, если активна запись в журнал на уровне отладки. Не рекомендуется использовать в производстве, поскольку в ответах OIDC может содержаться конфиденциальная информация.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание роли.
jwt_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

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

GET /auth/{kubernetes_mount_path}/config

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
kubernetes_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

POST /auth/{kubernetes_mount_path}/config

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
kubernetes_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
disable_iss_validationboolean (default: True)нет⚠️ Устарело. Отключить проверку эмитента JWT (устарело, будет удалено в будущем выпуске)
disable_local_ca_jwtboolean (default: False)нетОтключение использования по умолчанию локального сертификата CA и JWT учетной записи службы при запуске в стручке Kubernetes
issuerstringнет⚠️ Устарело. Необязательный эмитент JWT. Если эмитент не указан, то этот плагин будет использовать kubernetes.io/serviceaccount в качестве эмитента по умолчанию. (Утратил актуальность, будет удален в будущем выпуске)
kubernetes_ca_certstringнетНеобязательный сертификат CA в PEM-кодировке для использования TLS-клиентом, используемым для взаимодействия с API. Если он не задан и значение disable_local_ca_jwt равно true, будет использоваться пул сертификатов доверенного ЦС системы.
kubernetes_hoststringнетHost должен быть строкой хоста, парой хост:порт или URL-адресом базы сервера Kubernetes API.
pem_keysarrayнетНеобязательный список открытых ключей или сертификатов в PEM-формате, используемых для проверки подписей JWT-файлов учетных записей сервисов kubernetes. Если указан сертификат, будет извлечен его открытый ключ. Не каждая установка Kubernetes раскрывает эти ключи.
token_reviewer_jwtstringнетJWT учетной записи сервиса (или другой токен), используемый в качестве токена на предъявителя для доступа к API TokenReview для проверки других JWT при входе в систему. Если не задано, то для доступа к API будет использоваться JWT, используемый для входа в систему.
use_annotations_as_alias_metadataboolean (default: False)нетИспользование аннотаций из связанной с клиентским токеном учетной записи службы в качестве метаданных псевдонимов для сущности Vault. Будут использоваться только аннотации с префиксом “vault.hashicorp.com/alias-metadata-”. Обратите внимание, что Vault потребуется разрешение на чтение учетных записей сервисов из Kubernetes API.

Ответы

200: OK

POST /auth/{kubernetes_mount_path}/login

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

Аутентифицирует учетные записи службы Kubernetes с Vault.

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
kubernetes_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
jwtstringнетПодписанный JWT для проверки подлинности учетной записи службы. Это поле является обязательным.
rolestringнетНазвание роли, для которой осуществляется попытка входа. Это поле является обязательным

Ответы

200: OK

GET /auth/{kubernetes_mount_path}/role

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

Отображает все роли, зарегистрированные в бэкенде.

Параметры

ПараметрТипРасположениеОбязательныйОписание
kubernetes_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание роли.
kubernetes_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

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

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание роли.
kubernetes_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
alias_name_sourcestring (default: serviceaccount_uid)нетИсточник, который следует использовать при выведении имени псевдонима. допустимые варианты: “serviceaccount_uid” : <token.uid> например, 474b11b5-0f20-4f9d-8ca5-65715ab325e0 (наиболее безопасный вариант) “serviceaccount_name” : / например, vault/vault-agent default: “serviceaccount_uid”
audiencestringнетНеобязательное утверждение Аудитория для проверки в jwt.
bound_cidrsarrayнет⚠️ Устарело. Предпочтительно использовать “token_bound_cidrs”. Если указаны и “token_bound_cidrs”, то будет использоваться только “token_bound_cidrs”.
bound_service_account_namesarrayнетСписок имен учетных записей служб, имеющих доступ к этой роли. Если установлено значение “*”, разрешены все имена.
bound_service_account_namespace_selectorstringнетСелектор меток для пространств имен Kubernetes, которым разрешен доступ к этой роли. Принимает объект в формате JSON или YAML. Если задано вместе с bound_service_account_namespaces, условия объединяются.
bound_service_account_namespacesarrayнетСписок пространств имен, разрешенных для доступа к этой роли. Если установлено значение “*”, разрешены все пространства имен.
max_ttlintegerнет⚠️ Устарело. Предпочтительно использовать “token_max_ttl”. Если указаны и “token_max_ttl”, то будет использоваться только “token_max_ttl”.
num_usesintegerнет⚠️ Устарело. Предпочтительно использовать “token_num_uses”. Если указаны и “token_num_uses”, то будет использоваться только “token_num_uses”.
periodintegerнет⚠️ Устарело. Предпочтительно использовать “token_period”. Если указаны и “token_period”, то будет использоваться только “token_period”.
policiesarrayнет⚠️ Устарело. Предпочтительно использовать “token_policies”. Если указаны и “token_policies”, то будет использоваться только “token_policies”.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_explicit_max_ttlintegerнетЕсли установлено, то токены, созданные с помощью этой роли, будут иметь явный максимальный TTL. Во время обновления текущие максимальные значения TTL роли и монтирования не проверяются на изменения, и любые обновления этих значений не повлияют на обновляемый токен.
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).
token_policiesarrayнетСписок политик, разделенный запятыми
token_ttlintegerнетНачальный ttl генерируемого токена
token_typestring (default: default-service)нетТип генерируемого токена, сервисный или пакетный
ttlintegerнет⚠️ Устарело. Предпочтительно использовать “token_ttl”. Если указаны и “token_ttl”, и “token_ttl”, будет использоваться только “token_ttl”.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание роли.
kubernetes_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

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

GET /auth/{ldap_mount_path}/config

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

Настраивает LDAP сервер для подключения, вместе с его параметрами.

Параметры

ПараметрТипРасположениеОбязательныйОписание
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

POST /auth/{ldap_mount_path}/config

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

Настраивает LDAP сервер для подключения, вместе с его параметрами.

Параметры

ПараметрТипРасположениеОбязательныйОписание
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
anonymous_group_searchboolean (default: False)нетИспользовать анонимные привязки при поиске групп LDAP (если true, то исходные учетные данные все равно будут использоваться для первоначальной проверки соединения).
binddnstringнетLDAP DN для поиска DN пользователя (необязательно)
bindpassstringнетПароль LDAP для поиска DN пользователя (необязательно)
case_sensitive_namesbooleanнетЕсли значение равно true, то при сравнении имен пользователей и групп для сопоставления политик будет использоваться чувствительность к регистру.
certificatestringнетСертификат CA для использования при проверке сертификата сервера LDAP, должен быть в кодировке x509 PEM (необязательно)
client_tls_certstringнетСертификат клиента для предоставления серверу LDAP, должен быть закодирован x509 PEM (необязательно)
client_tls_keystringнетКлюч сертификата клиента для предоставления серверу LDAP, должен быть закодирован x509 PEM (необязательно)
connection_timeoutinteger (default: 30s)нетТайм-аут (в секундах) при попытке подключения к серверу LDAP перед попыткой перехода к следующему URL-адресу в конфигурации.
deny_null_bindboolean (default: True)нет⚠️ Устарело. Отклоняет неаутентифицированный запрос привязки LDAP, если пароль пользователя пуст; значение по умолчанию равно true
dereference_aliasesstring (never, finding, searching, always) (default: never)нетКогда псевдонимы должны разыменовываться при операциях поиска. Принимаемые значения: ‘никогда’, ‘находить’, ‘искать’, ‘всегда’. По умолчанию установлено значение ‘никогда’.
discoverdnbooleanнетИспользуйте анонимную привязку, чтобы узнать привязочный DN пользователя (необязательно).
enable_samaccountname_loginboolean (default: False)нетЕсли true (по умолчанию), новые пользователи могут регистрироваться самостоятельно. Если false, только предварительно созданные пользователи (через путь user/) могут регистрироваться.
groupattrstring (default: cn)нетАтрибут LDAP, который следует использовать для объектов, возвращаемых , чтобы перечислить принадлежность к группе пользователей. Примеры: “cn” или “memberOf” и т. д. По умолчанию: cn
groupdnstringнетБаза поиска LDAP, используемая для поиска членства в группе (например: ou=Groups,dc=example,dc=org)
groupfilterstring (default: (|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}})))нетШаблон Go для запроса принадлежности пользователя к группе (необязательно) Шаблон может обращаться к следующим контекстным переменным: UserDN, Username Пример: (&(objectClass=group)(member:1.2.840.113556.1.4.1941:={{.UserDN}})) По умолчанию: (|(memberUid={{.Username}})(member={.UserDN}})(uniqueMember={.UserDN}}))
insecure_tlsbooleanнетПропустите проверку SSL-сертификата сервера LDAP - ОЧЕНЬ небезопасно (необязательно)
max_page_sizeinteger (default: 0)нетЕсли установлено значение больше 0, бэкэнд LDAP будет использовать управление постраничным поиском сервера LDAP для запроса страниц до заданного размера. Это можно использовать, чтобы избежать столкновения с ограничением максимального размера результатов сервера LDAP. В противном случае бэкэнд LDAP не будет использовать управление постраничным поиском.
request_timeoutinteger (default: 90s)нетТаймаут в секундах для соединения при выполнении запросов к серверу до возврата ошибки.
starttlsbooleanнетВыполнять команду StartTLS после установления незашифрованного соединения (необязательно).
tls_max_versionstring (tls10, tls11, tls12, tls13) (default: tls12)нетМаксимальная версия TLS для использования. Принимаемые значения: ’tls10’, ’tls11’, ’tls12’ или ’tls13’. По умолчанию - ’tls12’
tls_min_versionstring (tls10, tls11, tls12, tls13) (default: tls12)нетМинимальная версия TLS для использования. Принимаемые значения: ’tls10’, ’tls11’, ’tls12’ или ’tls13’. По умолчанию используется значение ’tls12’.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_explicit_max_ttlintegerнетЕсли установлено, то токены, созданные с помощью этой роли, будут иметь явный максимальный TTL. Во время обновления текущие максимальные значения TTL роли и монтирования не проверяются на изменения, и любые обновления этих значений не повлияют на обновляемый токен.
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).
token_policiesarrayнетСписок политик, разделенный запятыми. Она будет применяться ко всем токенам, сгенерированным этим методом аутентификации, в дополнение к любым, настроенным для определенных пользователей/групп.
token_ttlintegerнетНачальный ttl генерируемого токена
token_typestring (default: default-service)нетТип генерируемого токена, сервисный или пакетный
upndomainstringнетРазрешает пользователюПринципалДомена входить в систему с [именем пользователя]@UPNDomain (необязательно).
urlstring (default: ldap://127.0.0.1)нетURL-адрес LDAP для подключения (по умолчанию: ldap://127.0.0.1). Можно указать несколько URL-адресов, соединив их запятыми; они будут опробованы в порядке убывания.
use_pre111_group_cn_behaviorbooleanнетВ Vault 1.1.1 исправление для обработки значений CN групп в разных случаях, к сожалению, внесло регрессию, которая могла привести к тому, что ранее определенные группы не были найдены из-за изменения результирующего имени. Если установлено значение true, будет использоваться поведение, существовавшее до версии 1.1.1, для соответствия CN групп. Это необходимо только в некоторых сценариях обновления для обратной совместимости. Она включается по умолчанию, если конфигурация обновляется, но отключается по умолчанию в новых конфигурациях.
use_token_groupsboolean (default: False)нетЕсли значение true, то для поиска членов групп используется построенный атрибут Active Directory tokenGroups пользователя. При этом будут найдены все группы безопасности, включая вложенные.
userattrstring (default: cn)нетАтрибут, используемый для пользователей (по умолчанию: cn)
userdnstringнетДомен LDAP, который будет использоваться для пользователей (например: ou=People,dc=example,dc=org)
userfilterstring (default: ({{.UserAttr}}={{.Username}}))нетШаблон Go для фильтра поиска пользователей LDAP (необязательно) Шаблон может обращаться к следующим контекстным переменным: UserAttr, Username По умолчанию: ({{.UserAttr}}={{.Username}})
username_as_aliasboolean (default: False)нетЕсли true, устанавливает имя псевдонима на имя пользователя

Ответы

200: OK

GET /auth/{ldap_mount_path}/groups

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание группы LDAP.
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание группы LDAP.
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
policiesarrayнетСписок политик, связанных с группой, разделенный запятыми.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание группы LDAP.
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

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

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

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

Войдите в систему, введя имя пользователя и пароль.

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
usernamestringpathдаDN (отличительное имя), которое будет использоваться для входа в систему.
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
passwordstringнетПароль для этого пользователя.

Ответы

200: OK

GET /auth/{ldap_mount_path}/users

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание пользователя LDAP.
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание пользователя LDAP.
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
groupsarrayнетСписок дополнительных групп, связанных с пользователем, разделенный запятыми.
policiesarrayнетСписок политик, связанных с пользователем, разделенный запятыми.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаНазвание пользователя LDAP.
ldap_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

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

POST /auth/{saml_mount_path}/callback

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
RelayStatestringдаSAML RelayState, прошедший полный цикл через IdP.
SAMLResponsestringдаSAML-ответ от провайдера удостоверений (IdP).

Ответы

200: OK

GET /auth/{saml_mount_path}/config

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

POST /auth/{saml_mount_path}/config

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
acs_urlsarrayдаURL Assertion Consumer Service, на которые IdP будет отправлять ответы. Должны быть корректно оформленными URL. Если какой-либо URL не защищён TLS, будет выдано предупреждение.
default_rolestringнетРоль по умолчанию, если при входе роль не указана. Если не задана, при входе роль обязательна.
entity_idstringдаEntity ID этого метода аутентификации в роли SAML Service Provider.
idp_certstringнетСертификат IdP в PEM, используемый для проверки подписей response и assertion. Взаимоисключающий с idp_metadata_url.
idp_entity_idstringнетEntity ID IdP. Взаимоисключающий с idp_metadata_url.
idp_metadata_urlstringнетURL метаданных IdP. Взаимоисключающий с idp_sso_url, idp_issuer и idp_cert. Должен быть корректно оформленным URL.
idp_sso_urlstringнетURL SSO IdP. Взаимоисключающий с idp_metadata_url. Должен быть корректно оформленным URL.
validate_assertion_signaturebooleanнетВключает проверку подписи как минимум для assertion в SAML-ответе. Если IdP подписывает и response, и assertion, рекомендуется включить проверку подписей обоих, активировав соответствующие отдельные параметры.
validate_response_signaturebooleanнетВключает проверку подписи как минимум для response в SAML-ответе. Если IdP подписывает и response, и assertion, рекомендуется включить проверку подписей обоих, активировав соответствующие отдельные параметры.
verbose_loggingbooleanнетДополнительное логирование при обмене SAML. Данные пользователя пишутся при уровне логирования debug, полный SAML-ответ — при уровне trace.

Ответы

200: OK

GET /auth/{saml_mount_path}/role

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя роли.
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя роли.
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
alias_metadataobjectнетМетаданные, привязываемые к создаваемому псевдониму сущности. Задаются списком или картой пар «ключ — значение».
bound_attributesobjectнетСопоставление имён атрибутов со значениями, наличие которых должно быть проверено в Assertion SAML Response.
bound_attributes_typestring (string, glob)нетТип сопоставления для пар ключ–значение в bound_attributes: при string — точное совпадение строк в значениях; при glob — подстановочные символы * в значениях.
bound_subjectsarrayнетSubject, который должен присутствовать в SAML Response. Subject в SAML Response должен совпадать с одним из настроенных значений.
bound_subjects_typestring (string, glob)нетТип сопоставления для bound_subject: при string — точное совпадение строки; при glob — подстановочные символы *.
groups_attributestringнетАтрибут, из которого берутся имена псевдонимов групп Vault Identity.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_explicit_max_ttlintegerнетЕсли установлено, то токены, созданные с помощью этой роли, будут иметь явный максимальный TTL. Во время обновления текущие максимальные значения TTL роли и монтирования не проверяются на изменения, и любые обновления этих значений не повлияют на обновляемый токен.
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).
token_policiesarrayнетСписок политик, разделенный запятыми
token_ttlintegerнетНачальный ttl генерируемого токена
token_typestring (default: default-service)нетТип генерируемого токена, сервисный или пакетный

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя роли.
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

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

POST /auth/{saml_mount_path}/sso_service_url

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
acs_urlstringнетURL Assertion Consumer Service для этого запроса аутентификации. Должен входить в список разрешённых URL в конфигурации.
client_challengestringдаКлиентский challenge: должен быть результатом base64-кодирования SHA256-хэша client_verifier, который затем передаётся в token API.
client_typestring (default: cli)нетТип клиента, инициирующего запрос. Ответ callback API Assertion Consumer Service зависит от указанного типа.
rolestringнетРоль, для которой выдаётся URL службы SSO.

Ответы

200: OK

POST /auth/{saml_mount_path}/token

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
saml_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
client_verifierstringдаЗначение, из которого сформирован client_challenge, переданный в API URL службы SSO в начале потока. Его SHA256-хэш в base64 должен совпадать с client_challenge.
token_poll_idstringдаЗначение token_poll_id, возвращённое API URL службы SSO в начале потока аутентификации.

Ответы

200: OK

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

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

Войдите в систему, введя имя пользователя и пароль.

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
usernamestringpathдаИмя пользователя.
userpass_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
passwordstringнетПароль для этого пользователя.

Ответы

200: OK

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
policy_namestringpathдаИмя пароля политики для userpass.
userpass_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

GET /auth/{userpass_mount_path}/users

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
userpass_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
usernamestringpathдаИмя пользователя для этого пользователя.
userpass_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

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

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
usernamestringpathдаИмя пользователя для этого пользователя.
userpass_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
bound_cidrsarrayнет⚠️ Устарело. Предпочтительно использовать “token_bound_cidrs”. Если указаны и “token_bound_cidrs”, то будет использоваться только “token_bound_cidrs”.
max_ttlintegerнет⚠️ Устарело. Предпочтительно использовать “token_max_ttl”. Если указаны и “token_max_ttl”, то будет использоваться только “token_max_ttl”.
passwordstringнетПароль для этого пользователя.
policiesarrayнет⚠️ Устарело. Предпочтительно использовать “token_policies”. Если указаны и “token_policies”, то будет использоваться только “token_policies”.
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_explicit_max_ttlintegerнетЕсли установлено, то токены, созданные с помощью этой роли, будут иметь явный максимальный TTL. Во время обновления текущие максимальные значения TTL роли и монтирования не проверяются на изменения, и любые обновления этих значений не повлияют на обновляемый токен.
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_num_usesintegerнетМаксимальное количество раз, которое может быть использован токен; значение ноль означает неограниченное количество раз.
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).
token_policiesarrayнетСписок политик, разделенный запятыми
token_ttlintegerнетНачальный ttl генерируемого токена
token_typestring (default: default-service)нетТип генерируемого токена, сервисный или пакетный
ttlintegerнет⚠️ Устарело. Предпочтительно использовать “token_ttl”. Если указаны и “token_ttl”, и “token_ttl”, будет использоваться только “token_ttl”.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
usernamestringpathдаИмя пользователя для этого пользователя.
userpass_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

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

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
usernamestringpathдаИмя пользователя для этого пользователя.
userpass_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
passwordstringнетПароль для этого пользователя.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
usernamestringpathдаИмя пользователя для этого пользователя.
userpass_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
policiesarrayнет⚠️ Устарело. Предпочтительно использовать “token_policies”. Если указаны и “token_policies”, то будет использоваться только “token_policies”.
token_policiesarrayнетСписок политик, разделенный запятыми

Ответы

200: OK

GET /auth/{webauthn_mount_path}/config

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

POST /auth/{webauthn_mount_path}/config

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
auto_registrationbooleanнетЕсли true (по умолчанию), новые пользователи могут регистрироваться самостоятельно. Если false, только предварительно созданные пользователи (через путь user/) могут регистрироваться.
rp_display_namestringнетОтображаемое имя для Relying Party
rp_idstringнет
rp_originsarrayнетРазрешенные источники для WebAuthn (например, https://vault.example.com, http://localhost:8200).

Ответы

200: OK

POST /auth/{webauthn_mount_path}/login/begin

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

Начать вход WebAuthn

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
usernamestringнетИмя пользователя для аутентификации (если не указано для потока discoverable/passkey: браузер покажет выбор пароля)

Ответы

200: OK

POST /auth/{webauthn_mount_path}/login/finish

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
credentialobjectнетОтвет аутентификатора (PublicKeyCredential с ответом)
usernamestringнетИмя пользователя (если не указано для потока discoverable: пользователь идентифицируется из assertion userHandle)

Ответы

200: OK

POST /auth/{webauthn_mount_path}/register/begin

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
usernamestringнетИмя пользователя для регистрации WebAuthn

Ответы

200: OK

POST /auth/{webauthn_mount_path}/register/finish

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
credentialobjectнетОтвет на создание учетных данных из аутентификатора (PublicKeyCredential с ответом)
usernamestringнетИмя пользователя, которое зарегистрировано

Ответы

200: OK

GET /auth/{webauthn_mount_path}/user

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд
liststring (true)queryдаДолжно быть установлено значение true.

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя пользователя
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

200: OK

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

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя пользователя
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
display_namestringнетОтображаемое имя для пользователя (по умолчанию username)
token_bound_cidrsarrayнетСтрока, разделенная запятыми, или JSON-список блоков CIDR. Если задано, указывает блоки IP-адресов, которым разрешено использовать сгенерированный токен.
token_max_ttlintegerнетМаксимальное время жизни сгенерированного токена
token_no_default_policybooleanнетЕсли true, политика “по умолчанию” не будет автоматически добавляться к сгенерированным токенам
token_periodintegerнетЕсли установлено, то токены, созданные с помощью этой роли, не будут иметь максимального срока службы; вместо этого их период обновления будет фиксирован на этом значении. Это значение принимает целое число секунд или строку продолжительности (например, “24 часа”).
token_policiesarrayнетСписок политик, разделенный запятыми
token_ttlintegerнетНачальный ttl генерируемого токена

Ответы

200: OK

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя пользователя
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

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

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
credential_idstringpathдаID учетных данных (base64url encoded)
namestringpathдаИмя пользователя
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

Ответы

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

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

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

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя пользователя
webauthn_mount_pathstringpathдаПуть, по которому был смонтирован бэкэнд

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

ПараметрТипОбязательныйОписание
token_policiesarrayнетСписок политик для сгенерированного токена

Ответы

200: OK