identity

POST /identity/alias

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

Создать новый псевдоним.

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

ПараметрТипОбязательныйОписание
canonical_idstringнетИдентификатор сущности, которой принадлежит этот псевдоним
entity_idstringнетИдентификатор сущности, которой принадлежит этот псевдоним. Это поле устарело в пользу ‘canonical_id’.
idstringнетИдентификатор псевдонима
mount_accessorstringнетАксессор точки монтирования, к которой относится этот псевдоним
namestringнетИмя псевдонима

Ответы

200: OK

GET /identity/alias/id

ID операции: alias-list-by-id

Получить список всех идентификаторов псевдонимов.

Параметры

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

Ответы

200: OK

GET /identity/alias/id/{id}

ID операции: alias-read-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

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

Ответы

200: OK

POST /identity/alias/id/{id}

ID операции: alias-update-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

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

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

ПараметрТипОбязательныйОписание
canonical_idstringнетИдентификатор сущности, к которой должен быть привязан этот псевдоним
entity_idstringнетИдентификатор сущности, к которой должен быть привязан этот псевдоним. Это поле устарело в пользу ‘canonical_id’.
mount_accessorstringнетАксессор точки монтирования, к которой относится этот псевдоним
namestringнетИмя псевдонима

Ответы

200: OK

DELETE /identity/alias/id/{id}

ID операции: alias-delete-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

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

Ответы

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

POST /identity/entity

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

Создать новую сущность

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

ПараметрТипОбязательныйОписание
disabledbooleanнетЕсли true, токены, привязанные к этой сущности, нельзя будет использовать (но они не будут отозваны).
idstringнетИдентификатор сущности. Если задан, обновляется соответствующая существующая сущность.
metadataobjectнетМетаданные, связываемые с сущностью. В CLI этот параметр можно указывать несколько раз, все значения объединяются. Например: stronghold metadata=key1=value1 metadata=key2=value2
namestringнетИмя сущности
policiesarrayнетПолитики, привязываемые к сущности.

Ответы

200: OK

POST /identity/entity-alias

ID операции: entity-create-alias

Создать новый псевдоним.

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

ПараметрТипОбязательныйОписание
canonical_idstringнетИдентификатор сущности, которой принадлежит этот псевдоним
custom_metadataobjectнетПредоставленные пользователем пары ключ-значение
entity_idstringнетИдентификатор сущности, которой принадлежит этот псевдоним. Это поле устарело, используйте canonical_id.
idstringнетИдентификатор псевдонима сущности. Если задан, обновляется соответствующий псевдоним сущности.
mount_accessorstringнетАксессор точки монтирования, к которой относится этот псевдоним; при изменении не используется
namestringнетИмя псевдонима; при изменении не используется

Ответы

200: OK

GET /identity/entity-alias/id

ID операции: entity-list-aliases-by-id

Получить список всех идентификаторов псевдонимов.

Параметры

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

Ответы

200: OK

GET /identity/entity-alias/id/{id}

ID операции: entity-read-alias-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

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

Ответы

200: OK

POST /identity/entity-alias/id/{id}

ID операции: entity-update-alias-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

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

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

ПараметрТипОбязательныйОписание
canonical_idstringнетИдентификатор сущности, к которой должен быть привязан этот псевдоним
custom_metadataobjectнетПредоставленные пользователем пары ключ-значение
entity_idstringнетИдентификатор сущности, которой принадлежит этот псевдоним. Это поле устарело, используйте canonical_id.
mount_accessorstringнет(Не используется)
namestringнет(Не используется)

Ответы

200: OK

DELETE /identity/entity-alias/id/{id}

ID операции: entity-delete-alias-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

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

Ответы

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

POST /identity/entity/batch-delete

ID операции: entity-batch-delete

Удалить все указанные сущности

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

ПараметрТипОбязательныйОписание
entity_idsarrayнетИдентификаторы сущностей для удаления

Ответы

200: OK

GET /identity/entity/id

ID операции: entity-list-by-id

Получить список всех идентификаторов сущностей

Параметры

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

Ответы

200: OK

GET /identity/entity/id/{id}

ID операции: entity-read-by-id

Обновить, прочитать или удалить сущность по идентификатору

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор сущности. Если задан, обновляется соответствующая существующая сущность.

Ответы

200: OK

POST /identity/entity/id/{id}

ID операции: entity-update-by-id

Обновить, прочитать или удалить сущность по идентификатору

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор сущности. Если задан, обновляется соответствующая существующая сущность.

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

ПараметрТипОбязательныйОписание
disabledbooleanнетЕсли true, токены, привязанные к этой сущности, нельзя будет использовать (но они не будут отозваны).
metadataobjectнетМетаданные, связываемые с сущностью. В CLI этот параметр можно указывать несколько раз, все значения объединяются. Например: stronghold metadata=key1=value1 metadata=key2=value2
namestringнетИмя сущности
policiesarrayнетПолитики, привязываемые к сущности.

Ответы

200: OK

DELETE /identity/entity/id/{id}

ID операции: entity-delete-by-id

Обновить, прочитать или удалить сущность по идентификатору

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор сущности. Если задан, обновляется соответствующая существующая сущность.

Ответы

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

POST /identity/entity/merge

ID операции: entity-merge

Объединить две или более сущностей

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

ПараметрТипОбязательныйОписание
conflicting_alias_ids_to_keeparrayнетИдентификаторы псевдонимов, которые следует сохранить при конфликте псевдонимов. Игнорируется, если конфликтов нет
forcebooleanнетЕсли задан, при слиянии секретов MFA применяется стратегия ‘mine’: если секреты одного типа есть и в объединяемых сущностях, и в целевой сущности, секреты целевой сущности не изменяются. Если не задан, API возвращает ошибку со списком всех конфликтов.
from_entity_idsarrayнетИдентификаторы объединяемых сущностей
to_entity_idstringнетИдентификатор сущности, в которую объединяются все остальные сущности

Ответы

200: OK

GET /identity/entity/name

ID операции: entity-list-by-name

Получить список всех имен сущностей

Параметры

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

Ответы

200: OK

GET /identity/entity/name/{name}

ID операции: entity-read-by-name

Обновить, прочитать или удалить сущность по имени

Параметры

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

Ответы

200: OK

POST /identity/entity/name/{name}

ID операции: entity-update-by-name

Обновить, прочитать или удалить сущность по имени

Параметры

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

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

ПараметрТипОбязательныйОписание
disabledbooleanнетЕсли true, токены, привязанные к этой сущности, нельзя будет использовать (но они не будут отозваны).
idstringнетИдентификатор сущности. Если задан, обновляется соответствующая существующая сущность.
metadataobjectнетМетаданные, связываемые с сущностью. В CLI этот параметр можно указывать несколько раз, все значения объединяются. Например: stronghold metadata=key1=value1 metadata=key2=value2
policiesarrayнетПолитики, привязываемые к сущности.

Ответы

200: OK

DELETE /identity/entity/name/{name}

ID операции: entity-delete-by-name

Обновить, прочитать или удалить сущность по имени

Параметры

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

Ответы

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

POST /identity/group

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

Создать новую группу.

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

ПараметрТипОбязательныйОписание
idstringнетИдентификатор группы. Если задан, обновляется соответствующая существующая группа.
member_entity_idsarrayнетИдентификаторы сущностей, назначаемых членами группы.
member_group_idsarrayнетИдентификаторы групп, назначаемых членами группы.
metadataobjectнетМетаданные, связываемые с группой. В CLI этот параметр можно указывать несколько раз, все значения объединяются. Например: stronghold metadata=key1=value1 metadata=key2=value2
namestringнетИмя группы.
policiesarrayнетПолитики, привязываемые к группе.
typestringнетТип группы: ‘internal’ или ’external’. По умолчанию ‘internal’

Ответы

200: OK

POST /identity/group-alias

ID операции: group-create-alias

Создает новый псевдоним группы или обновляет существующий.

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

ПараметрТипОбязательныйОписание
canonical_idstringнетИдентификатор группы, для которой создается этот псевдоним.
idstringнетИдентификатор псевдонима группы.
mount_accessorstringнетАксессор точки монтирования, к которой относится этот псевдоним.
namestringнетПсевдоним группы.

Ответы

200: OK

GET /identity/group-alias/id

ID операции: group-list-aliases-by-id

Получить список всех идентификаторов псевдонимов групп.

Параметры

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

Ответы

200: OK

GET /identity/group-alias/id/{id}

ID операции: group-read-alias-by-id

Параметры

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

Ответы

200: OK

POST /identity/group-alias/id/{id}

ID операции: group-update-alias-by-id

Параметры

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

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

ПараметрТипОбязательныйОписание
canonical_idstringнетИдентификатор группы, для которой создается этот псевдоним.
mount_accessorstringнетАксессор точки монтирования, к которой относится этот псевдоним.
namestringнетПсевдоним группы.

Ответы

200: OK

DELETE /identity/group-alias/id/{id}

ID операции: group-delete-alias-by-id

Параметры

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

Ответы

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

GET /identity/group/id

ID операции: group-list-by-id

Получить список всех идентификаторов групп.

Параметры

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

Ответы

200: OK

GET /identity/group/id/{id}

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

Обновить или удалить существующую группу по идентификатору.

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор группы. Если задан, обновляется соответствующая существующая группа.

Ответы

200: OK

POST /identity/group/id/{id}

ID операции: group-update-by-id

Обновить или удалить существующую группу по идентификатору.

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор группы. Если задан, обновляется соответствующая существующая группа.

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

ПараметрТипОбязательныйОписание
member_entity_idsarrayнетИдентификаторы сущностей, назначаемых членами группы.
member_group_idsarrayнетИдентификаторы групп, назначаемых членами группы.
metadataobjectнетМетаданные, связываемые с группой. В CLI этот параметр можно указывать несколько раз, все значения объединяются. Например: stronghold metadata=key1=value1 metadata=key2=value2
namestringнетИмя группы.
policiesarrayнетПолитики, привязываемые к группе.
typestringнетТип группы: ‘internal’ или ’external’. По умолчанию ‘internal’

Ответы

200: OK

DELETE /identity/group/id/{id}

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

Обновить или удалить существующую группу по идентификатору.

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор группы. Если задан, обновляется соответствующая существующая группа.

Ответы

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

GET /identity/group/name

ID операции: group-list-by-name

Параметры

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

Ответы

200: OK

GET /identity/group/name/{name}

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

Параметры

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

Ответы

200: OK

POST /identity/group/name/{name}

ID операции: group-update-by-name

Параметры

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

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

ПараметрТипОбязательныйОписание
idstringнетИдентификатор группы. Если задан, обновляется соответствующая существующая группа.
member_entity_idsarrayнетИдентификаторы сущностей, назначаемых членами группы.
member_group_idsarrayнетИдентификаторы групп, назначаемых членами группы.
metadataobjectнетМетаданные, связываемые с группой. В CLI этот параметр можно указывать несколько раз, все значения объединяются. Например: stronghold metadata=key1=value1 metadata=key2=value2
policiesarrayнетПолитики, привязываемые к группе.
typestringнетТип группы: ‘internal’ или ’external’. По умолчанию ‘internal’

Ответы

200: OK

DELETE /identity/group/name/{name}

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

Параметры

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

Ответы

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

POST /identity/lookup/entity

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

Поиск сущностей по различным свойствам.

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

ПараметрТипОбязательныйОписание
alias_idstringнетИдентификатор псевдонима.
alias_mount_accessorstringнетАксессор точки монтирования, к которой относится псевдоним. Указывается вместе с ‘alias_name’.
alias_namestringнетИмя псевдонима. Указывается вместе с ‘alias_mount_accessor’.
idstringнетИдентификатор сущности.
namestringнетИмя сущности.

Ответы

200: OK

POST /identity/lookup/group

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

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

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

ПараметрТипОбязательныйОписание
alias_idstringнетИдентификатор псевдонима.
alias_mount_accessorstringнетАксессор точки монтирования, к которой относится псевдоним. Указывается вместе с ‘alias_name’.
alias_namestringнетИмя псевдонима. Указывается вместе с ‘alias_mount_accessor’.
idstringнетИдентификатор группы.
namestringнетИмя группы.

Ответы

200: OK

GET /identity/mfa/login-enforcement

ID операции: mfa-list-login-enforcements

Получить список правил обязательного применения MFA при входе

Параметры

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

Ответы

200: OK

GET /identity/mfa/login-enforcement/{name}

ID операции: mfa-read-login-enforcement

Прочитать текущее правило обязательного применения MFA при входе

Параметры

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

Ответы

200: OK

POST /identity/mfa/login-enforcement/{name}

ID операции: mfa-write-login-enforcement

Создать или обновить правило обязательного применения MFA при входе

Параметры

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

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

ПараметрТипОбязательныйОписание
auth_method_accessorsarrayнетМассив идентификаторов аксессоров точек монтирования методов аутентификации
auth_method_typesarrayнетМассив типов точек монтирования методов аутентификации
identity_entity_idsarrayнетМассив идентификаторов сущностей Identity
identity_group_idsarrayнетМассив идентификаторов групп Identity
mfa_method_idsarrayдаМассив идентификаторов методов MFA, применение которых будет обязательным

Ответы

200: OK

DELETE /identity/mfa/login-enforcement/{name}

ID операции: mfa-delete-login-enforcement

Удалить правило обязательного применения MFA при входе

Параметры

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

Ответы

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

GET /identity/mfa/method

ID операции: mfa-list-methods

Получить список конфигураций для всех методов MFA

Параметры

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

Ответы

200: OK

GET /identity/mfa/method/duo

ID операции: mfa-list-duo-methods

Получить список конфигураций указанного метода MFA

Параметры

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

Ответы

200: OK

POST /identity/mfa/method/duo

ID операции: mfa-create-duo-method

Создать указанный метод MFA

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

ПараметрТипОбязательныйОписание
api_hostnamestringнетИмя хоста API Duo.
integration_keystringнетКлюч интеграции Duo.
method_namestringнетУникальное имя этого метода MFA.
push_infostringнетИнформация для push-уведомления Duo.
secret_keystringнетСекретный ключ Duo.
use_passcodebooleanнетЕсли true, при проверке MFA пользователю напоминается о возможности использовать код доступа (passcode). Использование кода доступа не становится обязательным. По умолчанию false.
username_formatstringнетСтрока шаблона для сопоставления имен Identity с именами методов MFA. Значения для подстановки указываются в {{}}. Например, “{{identity.entity.aliases.auth_userpass_abc123.name}}@example.com”. Если пусто, поле name сущности используется как есть.

Ответы

200: OK

GET /identity/mfa/method/duo/{method_id}

ID операции: mfa-read-duo-method-configuration

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

POST /identity/mfa/method/duo/{method_id}

ID операции: mfa-configure-duo-method

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

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

ПараметрТипОбязательныйОписание
api_hostnamestringнетИмя хоста API Duo.
integration_keystringнетКлюч интеграции Duo.
method_namestringнетУникальное имя этого метода MFA.
push_infostringнетИнформация для push-уведомления Duo.
secret_keystringнетСекретный ключ Duo.
use_passcodebooleanнетЕсли true, при проверке MFA пользователю напоминается о возможности использовать код доступа (passcode). Использование кода доступа не становится обязательным. По умолчанию false.
username_formatstringнетСтрока шаблона для сопоставления имен Identity с именами методов MFA. Значения для подстановки указываются в {{}}. Например, “{{identity.entity.aliases.auth_userpass_abc123.name}}@example.com”. Если пусто, поле name сущности используется как есть.

Ответы

200: OK

DELETE /identity/mfa/method/duo/{method_id}

ID операции: mfa-delete-duo-method

Удалить конфигурацию указанного метода MFA

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

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

GET /identity/mfa/method/multifactor

ID операции: mfa-list-multifactor-methods

Получить список конфигураций указанного метода MFA

Параметры

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

Ответы

200: OK

POST /identity/mfa/method/multifactor

ID операции: mfa-create-multifactor-method

Создать указанный метод MFA

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

ПараметрТипОбязательныйОписание
api_urlstringнетБазовый URL API Multifactor. По умолчанию “https://api.multifactor.ru”.
method_namestringнетУникальное имя этого метода MFA.
nas_identifierstringнетNAS Identifier Multifactor из настроек ресурса.
shared_secretstringнетShared Secret Multifactor из настроек ресурса.
timeout_secondsintegerнетМаксимальное время ожидания подтверждения push-уведомления Multifactor в секундах. По умолчанию 90, минимум 65.
username_formatstringнетСтрока шаблона для сопоставления имен Identity с идентификаторами пользователей Multifactor. Значения для подстановки указываются в {{}}. Например, “{{identity.entity.aliases.auth_userpass_abc123.name}}@example.com”. Если пусто, поле name сущности используется как есть.

Ответы

200: OK

GET /identity/mfa/method/multifactor/{method_id}

ID операции: mfa-read-multifactor-method-configuration

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

POST /identity/mfa/method/multifactor/{method_id}

ID операции: mfa-configure-multifactor-method

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

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

ПараметрТипОбязательныйОписание
api_urlstringнетБазовый URL API Multifactor. По умолчанию “https://api.multifactor.ru”.
method_namestringнетУникальное имя этого метода MFA.
nas_identifierstringнетNAS Identifier Multifactor из настроек ресурса.
shared_secretstringнетShared Secret Multifactor из настроек ресурса.
timeout_secondsintegerнетМаксимальное время ожидания подтверждения push-уведомления Multifactor в секундах. По умолчанию 90, минимум 65.
username_formatstringнетСтрока шаблона для сопоставления имен Identity с идентификаторами пользователей Multifactor. Значения для подстановки указываются в {{}}. Например, “{{identity.entity.aliases.auth_userpass_abc123.name}}@example.com”. Если пусто, поле name сущности используется как есть.

Ответы

200: OK

DELETE /identity/mfa/method/multifactor/{method_id}

ID операции: mfa-delete-multifactor-method

Удалить конфигурацию указанного метода MFA

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

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

GET /identity/mfa/method/okta

ID операции: mfa-list-okta-methods

Получить список конфигураций указанного метода MFA

Параметры

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

Ответы

200: OK

POST /identity/mfa/method/okta

ID операции: mfa-create-okta-method

Создать указанный метод MFA

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

ПараметрТипОбязательныйОписание
api_tokenstringнетКлюч API Okta.
base_urlstringнетБазовый домен API Okta. Если не указан в конфигурации, используется “okta.com”.
method_namestringнетУникальное имя этого метода MFA.
org_namestringнетИмя организации, используемое в API Okta.
primary_emailbooleanнетЕсли true, имя пользователя сопоставляется только с основным адресом электронной почты учетной записи. По умолчанию false.
productionbooleanнет(Устарело) Используйте вместо этого base_url.
username_formatstringнетСтрока шаблона для сопоставления имен Identity с именами методов MFA. Значения для подстановки указываются в {{}}. Например, “{{identity.entity.name}}@example.com”. Если пусто, поле name сущности используется как есть.

Ответы

200: OK

GET /identity/mfa/method/okta/{method_id}

ID операции: mfa-read-okta-method-configuration

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

POST /identity/mfa/method/okta/{method_id}

ID операции: mfa-configure-okta-method

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

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

ПараметрТипОбязательныйОписание
api_tokenstringнетКлюч API Okta.
base_urlstringнетБазовый домен API Okta. Если не указан в конфигурации, используется “okta.com”.
method_namestringнетУникальное имя этого метода MFA.
org_namestringнетИмя организации, используемое в API Okta.
primary_emailbooleanнетЕсли true, имя пользователя сопоставляется только с основным адресом электронной почты учетной записи. По умолчанию false.
productionbooleanнет(Устарело) Используйте вместо этого base_url.
username_formatstringнетСтрока шаблона для сопоставления имен Identity с именами методов MFA. Значения для подстановки указываются в {{}}. Например, “{{identity.entity.name}}@example.com”. Если пусто, поле name сущности используется как есть.

Ответы

200: OK

DELETE /identity/mfa/method/okta/{method_id}

ID операции: mfa-delete-okta-method

Удалить конфигурацию указанного метода MFA

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

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

GET /identity/mfa/method/pingid

ID операции: mfa-list-ping-id-methods

Получить список конфигураций указанного метода MFA

Параметры

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

Ответы

200: OK

POST /identity/mfa/method/pingid

ID операции: mfa-create-ping-id-method

Создать указанный метод MFA

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

ПараметрТипОбязательныйОписание
method_namestringнетУникальное имя этого метода MFA.
settings_file_base64stringнетФайл настроек от Ping в кодировке Base64. Должен быть файлом настроек для сторонних клиентов, а не для PingID SDK или PingFederate.
username_formatstringнетСтрока шаблона для сопоставления имен Identity с именами методов MFA. Значения для подстановки указываются в {{}}. Например, “{{identity.entity.aliases.auth_userpass_abc123.name}}@example.com”. Если пусто, поле name сущности используется как есть.

Ответы

200: OK

GET /identity/mfa/method/pingid/{method_id}

ID операции: mfa-read-ping-id-method-configuration

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

POST /identity/mfa/method/pingid/{method_id}

ID операции: mfa-configure-ping-id-method

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

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

ПараметрТипОбязательныйОписание
method_namestringнетУникальное имя этого метода MFA.
settings_file_base64stringнетФайл настроек от Ping в кодировке Base64. Должен быть файлом настроек для сторонних клиентов, а не для PingID SDK или PingFederate.
username_formatstringнетСтрока шаблона для сопоставления имен Identity с именами методов MFA. Значения для подстановки указываются в {{}}. Например, “{{identity.entity.aliases.auth_userpass_abc123.name}}@example.com”. Если пусто, поле name сущности используется как есть.

Ответы

200: OK

DELETE /identity/mfa/method/pingid/{method_id}

ID операции: mfa-delete-ping-id-method

Удалить конфигурацию указанного метода MFA

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

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

GET /identity/mfa/method/totp

ID операции: mfa-list-totp-methods

Получить список конфигураций указанного метода MFA

Параметры

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

Ответы

200: OK

POST /identity/mfa/method/totp

ID операции: mfa-create-totp-method

Создать указанный метод MFA

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

ПараметрТипОбязательныйОписание
algorithmstring (default: SHA1)нетАлгоритм хеширования для генерации TOTP-кода. Возможные значения: SHA1, SHA256 и SHA512.
digitsinteger (default: 6)нетКоличество цифр в генерируемом TOTP-коде: 6 или 8.
issuerstringнетНазвание организации, выдавшей ключ.
key_sizeinteger (default: 20)нетРазмер генерируемого ключа в байтах.
max_validation_attemptsintegerнетМаксимальное количество допустимых попыток проверки.
method_namestringнетУникальное имя этого метода MFA.
periodinteger (default: 30)нетДлительность интервала, используемого для вычисления счетчика при расчете TOTP-кода.
qr_sizeinteger (default: 200)нетРазмер генерируемого квадратного QR-кода в пикселях.
skewinteger (default: 1)нетКоличество периодов задержки, допустимых при проверке TOTP-кода: 0 или 1.

Ответы

200: OK

POST /identity/mfa/method/totp/admin-destroy

ID операции: mfa-admin-destroy-totp-secret

Удаляет TOTP-секрет для указанного идентификатора метода MFA у указанной сущности

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

ПараметрТипОбязательныйОписание
entity_idstringдаИдентификатор сущности, у которой нужно удалить секрет метода MFA.
method_idstringдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

POST /identity/mfa/method/totp/admin-generate

ID операции: mfa-admin-generate-totp-secret

Обновить или создать TOTP-секрет для указанного идентификатора метода у указанной сущности.

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

ПараметрТипОбязательныйОписание
entity_idstringдаИдентификатор сущности, для которой сохраняется сгенерированный секрет.
method_idstringдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

POST /identity/mfa/method/totp/generate

ID операции: mfa-generate-totp-secret

Обновить или создать TOTP-секрет для указанного идентификатора метода у указанной сущности.

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

ПараметрТипОбязательныйОписание
method_idstringдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

GET /identity/mfa/method/totp/{method_id}

ID операции: mfa-read-totp-method-configuration

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

POST /identity/mfa/method/totp/{method_id}

ID операции: mfa-configure-totp-method

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

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

ПараметрТипОбязательныйОписание
algorithmstring (default: SHA1)нетАлгоритм хеширования для генерации TOTP-кода. Возможные значения: SHA1, SHA256 и SHA512.
digitsinteger (default: 6)нетКоличество цифр в генерируемом TOTP-коде: 6 или 8.
issuerstringнетНазвание организации, выдавшей ключ.
key_sizeinteger (default: 20)нетРазмер генерируемого ключа в байтах.
max_validation_attemptsintegerнетМаксимальное количество допустимых попыток проверки.
method_namestringнетУникальное имя этого метода MFA.
periodinteger (default: 30)нетДлительность интервала, используемого для вычисления счетчика при расчете TOTP-кода.
qr_sizeinteger (default: 200)нетРазмер генерируемого квадратного QR-кода в пикселях.
skewinteger (default: 1)нетКоличество периодов задержки, допустимых при проверке TOTP-кода: 0 или 1.

Ответы

200: OK

DELETE /identity/mfa/method/totp/{method_id}

ID операции: mfa-delete-totp-method

Удалить конфигурацию указанного метода MFA

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

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

GET /identity/mfa/method/{method_id}

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

Прочитать текущую конфигурацию по указанному идентификатору независимо от типа метода MFA

Параметры

ПараметрТипРасположениеОбязательныйОписание
method_idstringpathдаУникальный идентификатор этого метода MFA.

Ответы

200: OK

GET /identity/oidc/.well-known/keys

ID операции: oidc-read-public-keys

Получить открытые ключи

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

Ответы

200: OK

GET /identity/oidc/.well-known/openid-configuration

ID операции: oidc-read-open-id-configuration

Запросить конфигурации OIDC

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

Ответы

200: OK

GET /identity/oidc/assignment

ID операции: oidc-list-assignments

Получить список назначений OIDC

Параметры

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

Ответы

200: OK

GET /identity/oidc/assignment/{name}

ID операции: oidc-read-assignment

CRUD-операции с назначениями OIDC.

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя назначения

Ответы

200: OK

POST /identity/oidc/assignment/{name}

ID операции: oidc-write-assignment

CRUD-операции с назначениями OIDC.

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя назначения

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

ПараметрТипОбязательныйОписание
entity_idsarrayнетСтрока через запятую или массив идентификаторов сущностей Identity
group_idsarrayнетСтрока через запятую или массив идентификаторов групп Identity

Ответы

200: OK

DELETE /identity/oidc/assignment/{name}

ID операции: oidc-delete-assignment

CRUD-операции с назначениями OIDC.

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя назначения

Ответы

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

GET /identity/oidc/client

ID операции: oidc-list-clients

Получить список клиентов OIDC

Параметры

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

Ответы

200: OK

GET /identity/oidc/client/{name}

ID операции: oidc-read-client

CRUD-операции с клиентами OIDC.

Параметры

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

Ответы

200: OK

POST /identity/oidc/client/{name}

ID операции: oidc-write-client

CRUD-операции с клиентами OIDC.

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

Параметры

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

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

ПараметрТипОбязательныйОписание
access_token_ttlinteger (default: 24h)нетВремя жизни токенов доступа, полученных клиентом.
assignmentsarrayнетСтрока через запятую или массив ресурсов назначений.
client_typestring (default: confidential)нетТип клиента в зависимости от его способности сохранять конфиденциальность учетных данных. Поддерживаемые типы: ‘confidential’, ‘public’. По умолчанию ‘confidential’.
id_token_ttlinteger (default: 24h)нетВремя жизни ID-токенов, полученных клиентом.
keystring (default: default)нетСсылка на именованный ключ. Нельзя изменить после создания. По умолчанию используется ключ ‘default’.
redirect_urisarrayнетСтрока через запятую или массив URI перенаправления клиента. Одно из этих значений должно точно совпадать со значением параметра redirect_uri в каждом запросе аутентификации.

Ответы

200: OK

DELETE /identity/oidc/client/{name}

ID операции: oidc-delete-client

CRUD-операции с клиентами OIDC.

Параметры

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

Ответы

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

GET /identity/oidc/config

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

Конфигурация OIDC

Ответы

200: OK

POST /identity/oidc/config

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

Конфигурация OIDC

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

ПараметрТипОбязательныйОписание
issuerstringнетURL издателя, используемый в утверждении iss токена. Если не задан, будет использоваться app_addr Stronghold.

Ответы

200: OK

POST /identity/oidc/introspect

ID операции: oidc-introspect

Проверить подлинность токена OIDC

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

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

Ответы

200: OK

GET /identity/oidc/key

ID операции: oidc-list-keys

Получить список ключей OIDC

Параметры

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

Ответы

200: OK

GET /identity/oidc/key/{name}

ID операции: oidc-read-key

CRUD-операции с ключами OIDC.

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя ключа

Ответы

200: OK

POST /identity/oidc/key/{name}

ID операции: oidc-write-key

CRUD-операции с ключами OIDC.

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

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя ключа

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

ПараметрТипОбязательныйОписание
algorithmstring (default: RS256)нетИспользуемый алгоритм подписи. По умолчанию RS256.
allowed_client_idsarrayнетСтрока через запятую или массив client ID ролей, которым разрешено подписывать этим ключом. Если пусто, не разрешено ни одной роли. Если “*”, разрешено всем ролям.
rotation_periodinteger (default: 24h)нетКак часто генерировать новую пару ключей.
verification_ttlinteger (default: 24h)нетСколько времени открытая часть ключа остается доступной для проверки после ротации.

Ответы

200: OK

DELETE /identity/oidc/key/{name}

ID операции: oidc-delete-key

CRUD-операции с ключами OIDC.

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя ключа

Ответы

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

POST /identity/oidc/key/{name}/rotate

ID операции: oidc-rotate-key

Выполнить ротацию именованного ключа OIDC.

Параметры

ПараметрТипРасположениеОбязательныйОписание
namestringpathдаИмя ключа

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

ПараметрТипОбязательныйОписание
verification_ttlintegerнетСколько времени открытая часть ключа остается доступной для проверки после ротации. Заданное здесь значение verification_ttl переопределяет verification_ttl ключа.

Ответы

200: OK

GET /identity/oidc/provider

ID операции: oidc-list-providers

Получить список провайдеров OIDC

Параметры

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

Ответы

200: OK

GET /identity/oidc/provider/{name}

ID операции: oidc-read-provider

CRUD-операции с провайдерами OIDC.

Параметры

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

Ответы

200: OK

POST /identity/oidc/provider/{name}

ID операции: oidc-write-provider

CRUD-операции с провайдерами OIDC.

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

Параметры

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

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

ПараметрТипОбязательныйОписание
allowed_client_idsarrayнетИдентификаторы клиентов, которым разрешено использовать провайдера
issuerstringнетОпределяет значение утверждения iss в ID-токенах.
scopes_supportedarrayнетОбласти (scopes), которые можно запрашивать у провайдера

Ответы

200: OK

DELETE /identity/oidc/provider/{name}

ID операции: oidc-delete-provider

CRUD-операции с провайдерами OIDC.

Параметры

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

Ответы

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

GET /identity/oidc/provider/{name}/.well-known/keys

ID операции: oidc-read-provider-public-keys

Получить открытые ключи

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

Параметры

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

Ответы

200: OK

GET /identity/oidc/provider/{name}/.well-known/openid-configuration

ID операции: oidc-read-provider-open-id-configuration

Запросить конфигурации OIDC

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

Параметры

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

Ответы

200: OK

GET /identity/oidc/provider/{name}/authorize

ID операции: oidc-provider-authorize

Конечная точка авторизации OIDC.

Параметры

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

Ответы

200: OK

POST /identity/oidc/provider/{name}/authorize

ID операции: oidc-provider-authorize-with-parameters

Конечная точка авторизации OIDC.

Параметры

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

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

ПараметрТипОбязательныйОписание
client_idstringдаИдентификатор запрашивающего клиента.
code_challengestringнетCode challenge, полученный из code verifier.
code_challenge_methodstring (default: plain)нетМетод получения code challenge. Поддерживаемые методы: ‘S256’, ‘plain’. По умолчанию ‘plain’.
max_ageintegerнетДопустимое время в секундах, прошедшее с момента последней активной аутентификации конечного пользователя.
noncestringнетЗначение, возвращаемое в утверждении nonce ID-токена после обмена токенов.
redirect_uristringдаURI перенаправления, на который будет отправлен ответ.
response_typestringдаИспользуемый поток аутентификации OIDC. Поддерживаемые типы ответа: ‘code’
scopestringдаСписок запрашиваемых областей (scopes) через пробел, с учетом регистра. Область ‘openid’ обязательна.
statestringнетЗначение для сохранения состояния между запросом аутентификации и обратным вызовом клиента.

Ответы

200: OK

POST /identity/oidc/provider/{name}/token

ID операции: oidc-provider-token

Конечная точка токена OIDC.

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

Параметры

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

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

ПараметрТипОбязательныйОписание
client_idstringнетИдентификатор запрашивающего клиента.
client_secretstringнетСекрет запрашивающего клиента.
codestringдаКод авторизации, полученный от конечной точки авторизации провайдера.
code_verifierstringнетCode verifier, связанный с кодом авторизации.
grant_typestringдаТип разрешения на авторизацию (grant type). Поддерживаемые типы: ‘authorization_code’.
redirect_uristringдаАдрес обратного вызова, на который был отправлен ответ аутентификации.

Ответы

200: OK

GET /identity/oidc/provider/{name}/userinfo

ID операции: oidc-provider-user-info

Конечная точка UserInfo OIDC.

Параметры

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

Ответы

200: OK

POST /identity/oidc/provider/{name}/userinfo

ID операции: oidc-provider-user-info2

Конечная точка UserInfo OIDC.

Параметры

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

Ответы

200: OK

GET /identity/oidc/role

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

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

Параметры

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

Ответы

200: OK

GET /identity/oidc/role/{name}

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

CRUD-операции с ролями OIDC

Параметры

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

Ответы

200: OK

POST /identity/oidc/role/{name}

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

CRUD-операции с ролями OIDC

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

Параметры

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

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

ПараметрТипОбязательныйОписание
client_idstringнетНеобязательный client_id
keystringдаКлюч OIDC для генерации токенов. Указанный ключ должен уже существовать.
templatestringнетСтрока шаблона для генерации токенов: JSON, сериализованный в строку, или base64.
ttlinteger (default: 24h)нетTTL токенов, сгенерированных для роли.

Ответы

200: OK

DELETE /identity/oidc/role/{name}

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

CRUD-операции с ролями OIDC

Параметры

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

Ответы

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

GET /identity/oidc/scope

ID операции: oidc-list-scopes

Получить список областей (scopes) OIDC

Параметры

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

Ответы

200: OK

GET /identity/oidc/scope/{name}

ID операции: oidc-read-scope

CRUD-операции с областями (scopes) OIDC.

Параметры

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

Ответы

200: OK

POST /identity/oidc/scope/{name}

ID операции: oidc-write-scope

CRUD-операции с областями (scopes) OIDC.

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

Параметры

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

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

ПараметрТипОбязательныйОписание
descriptionstringнетОписание области
templatestringнетСтрока шаблона для области: JSON, сериализованный в строку, или base64.

Ответы

200: OK

DELETE /identity/oidc/scope/{name}

ID операции: oidc-delete-scope

CRUD-операции с областями (scopes) OIDC.

Параметры

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

Ответы

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

GET /identity/oidc/token/{name}

ID операции: oidc-generate-token

Генерирует токен OIDC

Параметры

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

Ответы

200: OK

POST /identity/persona

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

Создать новый псевдоним.

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

ПараметрТипОбязательныйОписание
entity_idstringнетИдентификатор сущности, к которой принадлежит эта персона
idstringнетИдентификатор персоны
metadataobjectнетМетаданные, связываемые с персоной. В CLI этот параметр можно указывать несколько раз, все значения объединяются. Например: stronghold metadata=key1=value1 metadata=key2=value2
mount_accessorstringнетАксессор точки монтирования, к которой относится эта персона
namestringнетИмя персоны

Ответы

200: OK

GET /identity/persona/id

ID операции: persona-list-by-id

Получить список всех идентификаторов псевдонимов.

Параметры

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

Ответы

200: OK

GET /identity/persona/id/{id}

ID операции: persona-read-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор персоны

Ответы

200: OK

POST /identity/persona/id/{id}

ID операции: persona-update-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор персоны

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

ПараметрТипОбязательныйОписание
entity_idstringнетИдентификатор сущности, к которой должна быть привязана эта персона
metadataobjectнетМетаданные, связываемые с персоной. В CLI этот параметр можно указывать несколько раз, все значения объединяются. Например: stronghold metadata=key1=value1 metadata=key2=value2
mount_accessorstringнетАксессор точки монтирования, к которой относится эта персона
namestringнетИмя персоны

Ответы

200: OK

DELETE /identity/persona/id/{id}

ID операции: persona-delete-by-id

Обновить, прочитать или удалить псевдоним по идентификатору.

Параметры

ПараметрТипРасположениеОбязательныйОписание
idstringpathдаИдентификатор персоны

Ответы

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

←
API / secrets
API / system
→