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

Обновить, прочитать или удалить сущность, используя её ID

Параметры

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

Ответы

200: OK

POST /identity/entity/id/{id}

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

Обновить, прочитать или удалить сущность, используя её 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

Обновить, прочитать или удалить сущность, используя её ID

Параметры

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

Ответы

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

POST /identity/entity/merge

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

Слияние двух или более организаций

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

ПараметрТипОбязательныйОписание
conflicting_alias_ids_to_keeparrayнетИдентификаторы псевдонимов, которые следует сохранить в случае конфликтующих псевдонимов. Игнорируется, если конфликтующие псевдонимы не найдены
forcebooleanнетУстановка этого параметра будет следовать стратегии ‘mine’ для слияния секретов MFA. Если секреты одного типа есть как в сущностях, из которых происходит слияние, так и в сущности, в которую сливаются все остальные, секреты в пункте назначения не будут изменены. Если значение не задано, этот 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нетТип группы, “внутренняя” или “внешняя”. По умолчанию - ‘внутренняя’

Ответы

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

Обновить или удалить существующую группу, используя её ID.

Параметры

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

Ответы

200: OK

POST /identity/group/id/{id}

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

Обновить или удалить существующую группу, используя её ID.

Параметры

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

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

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

Ответы

200: OK

DELETE /identity/group/id/{id}

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

Обновить или удалить существующую группу, используя её 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нетТип группы, “внутренняя” или “внешняя”. По умолчанию - ‘внутренняя’

Ответы

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

Список принудительных мер по входу в систему

Параметры

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

Ответы

200: OK

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

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

Считывает текущий логин

Параметры

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

Ответы

200: OK

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

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

Создает или обновляет принудительный вход в систему

Параметры

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

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

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

Ответы

200: OK

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

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

Удаление принудительного входа в систему

Параметры

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

Ответы

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

GET /identity/mfa/method

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

Отображает список конфигураций методов MFA для всех методов MFA

Параметры

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

Ответы

200: OK

GET /identity/mfa/method/duo

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

Отображает список конфигураций методов MFA для данного метода 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нетИнформация о нажатии для Дуо.
secret_keystringнетСекретный ключ для Дуо.
use_passcodebooleanнетЕсли значение равно true, то при проверке MFA пользователю будет напоминаться о необходимости использования пароля. Этот параметр не принуждает к использованию пароля. По умолчанию установлено значение false.
username_formatstringнетСтрока-шаблон для сопоставления имен идентификаторов с именами методов MFA. Значения для подстановки должны быть помещены в {{}}. Например, “{{alias.name}}@example.com”. Поддерживаемые в настоящее время сопоставления: alias.name: имя, возвращаемое монтированием, настроенным через параметр mount_accessor Если пусто, поле имени псевдонима будет использоваться как есть.

Ответы

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нетИнформация о нажатии для Дуо.
secret_keystringнетСекретный ключ для Дуо.
use_passcodebooleanнетЕсли значение равно true, то при проверке MFA пользователю будет напоминаться о необходимости использования пароля. Этот параметр не принуждает к использованию пароля. По умолчанию установлено значение false.
username_formatstringнетСтрока-шаблон для сопоставления имен идентификаторов с именами методов MFA. Значения для подстановки должны быть помещены в {{}}. Например, “{{alias.name}}@example.com”. Поддерживаемые в настоящее время сопоставления: alias.name: имя, возвращаемое монтированием, настроенным через параметр mount_accessor Если пусто, поле имени псевдонима будет использоваться как есть.

Ответы

200: OK

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

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

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

Параметры

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

Ответы

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

GET /identity/mfa/method/okta

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

Отображает список конфигураций методов MFA для данного метода 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нетНазвание организации, которое будет использоваться в Okta API.
primary_emailbooleanнетЕсли значение равно true, имя пользователя будет соответствовать только основному электронному адресу учетной записи. По умолчанию установлено значение false.
productionbooleanнет(DEPRECATED) Предпочтительно использовать base_url.
username_formatstringнетСтрока-шаблон для сопоставления имен идентификаторов с именами методов MFA. Заменяемые значения должны быть помещены в {{}}. Например, “{{entity.name}}@example.com”. Если поле имени сущности пустое, оно будет использоваться как есть.

Ответы

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нетНазвание организации, которое будет использоваться в Okta API.
primary_emailbooleanнетЕсли значение равно true, имя пользователя будет соответствовать только основному электронному адресу учетной записи. По умолчанию установлено значение false.
productionbooleanнет(DEPRECATED) Предпочтительно использовать base_url.
username_formatstringнетСтрока-шаблон для сопоставления имен идентификаторов с именами методов MFA. Заменяемые значения должны быть помещены в {{}}. Например, “{{entity.name}}@example.com”. Если поле имени сущности пустое, оно будет использоваться как есть.

Ответы

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 для данного метода 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нетСтрока-шаблон для сопоставления имен идентификаторов с именами методов MFA. Значения для подстановки должны быть помещены в {{}}. Например, “{{alias.name}}@example.com”. Поддерживаемые в настоящее время сопоставления: alias.name: имя, возвращаемое монтированием, настроенным через параметр mount_accessor Если пусто, поле имени псевдонима будет использоваться как есть.

Ответы

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нетСтрока-шаблон для сопоставления имен идентификаторов с именами методов MFA. Значения для подстановки должны быть помещены в {{}}. Например, “{{alias.name}}@example.com”. Поддерживаемые в настоящее время сопоставления: alias.name: имя, возвращаемое монтированием, настроенным через параметр mount_accessor Если пусто, поле имени псевдонима будет использоваться как есть.

Ответы

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 для данного метода 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

Прочитайте текущую конфигурацию для данного ID независимо от типа метода 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нетСтрока или массив идентификаторов субъектов идентификации, разделенные запятыми
group_idsarrayнетСтрока или массив идентификаторов групп идентификации, разделенные запятыми

Ответы

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)нетТип клиента зависит от его способности сохранять конфиденциальность учетных данных. Поддерживаются следующие типы клиентов: ‘конфиденциальный’, ‘публичный’. По умолчанию используется значение ‘конфиденциальный’.
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.

Ответы

200: OK

POST /identity/oidc/introspect

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

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

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

ПараметрТипОбязательныйОписание
client_idstringнетНеобязательный идентификатор клиента для проверки
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нетСтрока или массив идентификаторов клиентов ролей, которым разрешено использовать этот ключ для подписи, разделенные запятыми. Если пусто, то ни одна роль не разрешена. Если “*”, то разрешены все роли.
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 до тех, которые допускают заданный идентификатор клиента в своем наборе разрешенных_клиентских_идентификаторов.
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.
scopes_supportedarrayнетОбласти, поддерживаемые для запросов к провайдеру

Ответы

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_methodstring (default: plain)нетМетод, который был использован для получения кода вызова. Поддерживаются следующие методы: ‘S256’, ‘plain’. По умолчанию используется ‘plain’.
max_ageintegerнетДопустимое время в секундах, прошедшее с момента последней активной аутентификации конечного пользователя.
noncestringнетЗначение, которое будет возвращено в утверждении ID token nonce после обмена токенами.
redirect_uristringдаURI перенаправления, на который будет отправлен ответ.
response_typestringдаИспользуемый поток аутентификации OIDC. Поддерживаются следующие типы ответов: ‘code’
scopestringдаОграниченный пробелами, чувствительный к регистру список областей, которые необходимо запросить. Область ‘openid’ является обязательной.
statestringнетЗначение, используемое для сохранения состояния между запросом аутентификации и клиентом.

Ответы

200: OK

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

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

Предоставляет конечную точку токена OIDC.

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

Параметры

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

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

ПараметрТипОбязательныйОписание
client_idstringнетИдентификатор запрашивающего клиента.
client_secretstringнетСекрет запрашивающего клиента.
codestringдаКод авторизации, полученный от конечной точки авторизации провайдера.
code_verifierstringнетВерификатор кода, связанный с кодом авторизации.
grant_typestringдаТип гранта авторизации. Поддерживаются следующие типы грантов: ‘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нетНеобязательный идентификатор клиента
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

Отображает список областей OIDC

Параметры

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

Ответы

200: OK

GET /identity/oidc/scope/{name}

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

Операции CRUD для областей OIDC.

Параметры

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

Ответы

200: OK

POST /identity/oidc/scope/{name}

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

Операции CRUD для областей OIDC.

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

Параметры

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

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

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

Ответы

200: OK

DELETE /identity/oidc/scope/{name}

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

Операции CRUD для областей 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: пустое тело