Okta
Управление пользователями и группами в Okta
Okta — это платформа управления идентификацией и доступом, которая обеспечивает безопасную аутентификацию, авторизацию и управление пользователями для организаций.
С помощью интеграции Okta в AACFlow вы можете:
- Списывать и искать пользователей: Получать пользователей из вашей организации Okta с помощью выражений поиска SCIM и фильтров
- Управлять жизненным циклом пользователей: Создавать, активировать, деактивировать, приостанавливать, возобновлять и удалять пользователей
- Обновлять профили пользователей: Изменять атрибуты пользователей, такие как имя, email, телефон, должность и отдел
- Сбрасывать пароли: Запускать процессы сброса пароля с опциональным уведомлением по email
- Управлять группами: Создавать, обновлять, удалять и спискировать группы в вашей организации
- Управлять членством в группах: Добавлять или удалять пользователей из групп и спискировать членов групп
В AACFlow интеграция Okta позволяет вашим агентам автоматизировать задачи управления идентификацией в рамках их рабочих процессов. Это позволяет реализовать такие сценарии, как онбординг новых сотрудников, оффбординг уходящих пользователей, управление доступом на основе групп, аудит статуса пользователей и реагирование на события безопасности путем приостановки или деактивации учетных записей.
Если у вас возникли проблемы с интеграцией Okta, свяжитесь с нами по адресу help@aacflow.io
Интегрируйте управление идентификацией Okta в ваш рабочий процесс. Спискируйте, создавайте, обновляйте, активируйте, приостанавливайте и удаляйте пользователей. Сбрасывайте пароли. Управляйте группами и членством в группах.
Список всех пользователей в вашей организации Okta с опциональным поиском и фильтрацией
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
search | string | Нет | Выражение поиска Okta (например, profile.firstName eq "John" или profile.email co "example.com") |
filter | string | Нет | Выражение фильтра Okta (например, status eq "ACTIVE") |
limit | number | Нет | Максимальное количество пользователей для возврата (по умолчанию: 200, максимум: 200) |
| Параметр | Тип | Описание |
|---|
users | array | Массив объектов пользователей Okta |
↳ id | string | ID пользователя |
↳ status | string | Статус пользователя (ACTIVE, STAGED, PROVISIONED и т.д.) |
↳ firstName | string | Имя |
↳ lastName | string | Фамилия |
↳ email | string | Адрес электронной почты |
↳ login | string | Логин (обычно email) |
↳ mobilePhone | string | Мобильный телефон |
↳ title | string | Должность |
↳ department | string | Отдел |
↳ created | string | Временная метка создания |
↳ lastLogin | string | Временная метка последнего входа |
↳ lastUpdated | string | Временная метка последнего обновления |
↳ activated | string | Временная метка активации |
↳ statusChanged | string | Временная метка изменения статуса |
count | number | Количество возвращенных пользователей |
success | boolean | Статус успеха операции |
Получить конкретного пользователя по ID или логину из вашей организации Okta
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okта (например, dev-123456.okta.com) |
userId | string | Да | ID пользователя или логин (email) для поиска |
| Параметр | Тип | Описание |
|---|
id | string | ID пользователя |
status | string | Статус пользователя |
firstName | string | Имя |
lastName | string | Фамилия |
email | string | Адрес электронной почты |
login | string | Логин (обычно email) |
mobilePhone | string | Мобильный телефон |
secondEmail | string | Вторичный email |
displayName | string | Отображаемое имя |
title | string | Должность |
department | string | Отдел |
organization | string | Организация |
manager | string | Имя менеджера |
managerId | string | ID менеджера |
division | string | Подразделение |
employeeNumber | string | Номер сотрудника |
userType | string | Тип пользователя |
created | string | Временная метка создания |
activated | string | Временная метка активации |
lastLogin | string | Временная метка последнего входа |
lastUpdated | string | Временная метка последнего обновления |
statusChanged | string | Временная метка изменения статуса |
passwordChanged | string | Временная метка изменения пароля |
success | boolean | Статус успеха операции |
Создать нового пользователя в вашей организации Okta
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
firstName | string | Да | Имя пользователя |
lastName | string | Да | Фамилия пользователя |
email | string | Да | Адрес электронной почты пользователя |
login | string | Нет | Логин для пользователя (по умолчанию используется email, если не указан) |
password | string | Нет | Пароль для пользователя (если не установлен, пользователю будет отправлено письмо для установки пароля) |
mobilePhone | string | Нет | Номер мобильного телефона |
title | string | Нет | Должность |
department | string | Нет | Отдел |
activate | boolean | Нет | Активировать ли пользователя немедленно (по умолчанию: true) |
| Параметр | Тип | Описание |
|---|
id | string | ID созданного пользователя |
status | string | Статус пользователя |
firstName | string | Имя |
lastName | string | Фамилия |
email | string | Адрес электронной почты |
login | string | Логин |
created | string | Временная метка создания |
lastUpdated | string | Временная метка последнего обновления |
success | boolean | Статус успеха операции |
Обновить профиль пользователя в вашей организации Okta
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
userId | string | Да | ID пользователя или логин для обновления |
firstName | string | Нет | Обновленное имя |
lastName | string | Нет | Обновленная фамилия |
email | string | Нет | Обновленный адрес электронной почты |
login | string | Нет | Обновленный логин |
mobilePhone | string | Нет | Обновленный номер мобильного телефона |
title | string | Нет | Обновленная должность |
department | string | Нет | Обновленный отдел |
| Параметр | Тип | Описание |
|---|
id | string | ID пользователя |
status | string | Статус пользователя |
firstName | string | Имя |
lastName | string | Фамилия |
email | string | Адрес электронной почты |
login | string | Логин |
created | string | Временная метка создания |
lastUpdated | string | Временная метка последнего обновления |
success | boolean | Статус успеха операции |
Активировать пользователя в вашей организации Okta. Может быть выполнено только для пользователей со статусом STAGED или DEPROVISIONED. Опционально отправляет email активации.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
userId | string | Да | ID пользователя или логин для активации |
sendEmail | boolean | Нет | Отправлять email активации пользователю (по умолчанию: true) |
| Параметр | Тип | Описание |
|---|
userId | string | ID активированного пользователя |
activated | boolean | Был ли пользователь активирован |
activationUrl | string | URL активации (возвращается только когда sendEmail равно false) |
activationToken | string | Токен активации (возвращается только когда sendEmail равно false) |
success | boolean | Статус успеха операции |
Деактивировать пользователя в вашей организации Okta. Это переводит пользователя в статус DEPROVISIONED.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
userId | string | Да | ID пользователя или логин для деактивации |
sendEmail | boolean | Нет | Отправлять email деактивации администратору (по умолчанию: false) |
| Параметр | Тип | Описание |
|---|
userId | string | ID деактивированного пользователя |
deactivated | boolean | Был ли пользователь деактивирован |
success | boolean | Статус успеха операции |
Приостановить пользователя в вашей организации Okta. Только пользователи со статусом ACTIVE могут быть приостановлены. Приостановленные пользователи не могут входить в систему, но сохраняют назначения групп и приложений.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
userId | string | Да | ID пользователя или логин для приостановки |
| Параметр | Тип | Описание |
|---|
userId | string | ID приостановленного пользователя |
suspended | boolean | Был ли пользователь приостановлен |
success | boolean | Статус успеха операции |
Возобновить ранее приостановленного пользователя в вашей организации Okta. Возвращает пользователя в статус ACTIVE.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
userId | string | Да | ID пользователя или логин для возобновления |
| Параметр | Тип | Описание |
|---|
userId | string | ID возобновленного пользователя |
unsuspended | boolean | Был ли пользователь возобновлен |
success | boolean | Статус успеха операции |
Сгенерировать одноразовый токен для сброса пароля пользователя. Может отправить ссылку сброса пользователю по email или вернуть ее напрямую. Переводит пользователя в статус RECOVERY.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
userId | string | Да | ID пользователя или логин для сброса пароля |
sendEmail | boolean | Нет | Отправлять email сброса пароля пользователю (по умолчанию: true) |
| Параметр | Тип | Описание |
|---|
userId | string | ID пользователя |
resetPasswordUrl | string | URL сброса пароля (возвращается только когда sendEmail равно false) |
success | boolean | Статус успеха операции |
Навсегда удалить пользователя из вашей организации Okta. Может быть выполнено только для пользователей со статусом DEPROVISIONED. Если пользователь активен, сначала будет выполнена деактивация, и для удаления потребуется второй вызов.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
userId | string | Да | ID пользователя для удаления |
sendEmail | boolean | Нет | Отправлять email деактивации администратору (по умолчанию: false) |
| Параметр | Тип | Описание |
|---|
userId | string | ID удаленного пользователя |
deleted | boolean | Был ли пользователь удален |
success | boolean | Статус успеха операции |
Список всех групп в вашей организации Okta с опциональным поиском и фильтрацией
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
search | string | Нет | Выражение поиска Okta для групп (например, profile.name sw "Engineering" или type eq "OKTA_GROUP") |
filter | string | Нет | Выражение фильтра Okta (например, type eq "OKTA_GROUP") |
limit | number | Нет | Максимальное количество групп для возврата (по умолчанию: 10000, максимум: 10000) |
| Параметр | Тип | Описание |
|---|
groups | array | Массив объектов групп Okta |
↳ id | string | ID группы |
↳ name | string | Имя группы |
↳ description | string | Описание группы |
↳ type | string | Тип группы (OKTA_GROUP, APP_GROUP, BUILT_IN) |
↳ created | string | Временная метка создания |
↳ lastUpdated | string | Временная метка последнего обновления |
↳ lastMembershipUpdated | string | Временная метка последнего изменения членства |
count | number | Количество возвращенных групп |
success | boolean | Статус успеха операции |
Получить конкретную группу по ID из вашей организации Okta
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
groupId | string | Да | ID группы для поиска |
| Параметр | Тип | Описание |
|---|
id | string | ID группы |
name | string | Имя группы |
description | string | Описание группы |
type | string | Тип группы |
created | string | Временная метка создания |
lastUpdated | string | Временная метка последнего обновления |
lastMembershipUpdated | string | Временная метка последнего изменения членства |
success | boolean | Статус успеха операции |
Создать новую группу в вашей организации Okta
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
name | string | Да | Имя группы |
description | string | Нет | Описание группы |
| Параметр | Тип | Описание |
|---|
id | string | ID созданной группы |
name | string | Имя группы |
description | string | Описание группы |
type | string | Тип группы |
created | string | Временная метка создания |
lastUpdated | string | Временная метка последнего обновления |
lastMembershipUpdated | string | Временная метка последнего изменения членства |
success | boolean | Статус успеха операции |
Обновить профиль группы в вашей организации Okta. Только группы типа OKTA_GROUP могут быть обновлены. Все свойства профиля должны быть указаны (полная замена).
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
groupId | string | Да | ID группы для обновления |
name | string | Да | Обновленное имя группы |
description | string | Нет | Обновленное описание группы |
| Параметр | Тип | Описание |
|---|
id | string | ID группы |
name | string | Имя группы |
description | string | Описание группы |
type | string | Тип группы |
created | string | Временная метка создания |
lastUpdated | string | Временная метка последнего обновления |
lastMembershipUpdated | string | Временная метка последнего изменения членства |
success | boolean | Статус успеха операции |
Удалить группу из вашей организации Okta. Группы типа OKTA_GROUP или APP_GROUP могут быть удалены.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
groupId | string | Да | ID группы для удаления |
| Параметр | Тип | Описание |
|---|
groupId | string | ID удаленной группы |
deleted | boolean | Была ли группа удалена |
success | boolean | Статус успеха операции |
Добавить пользователя в группу в вашей организации Okta
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
groupId | string | Да | ID группы для добавления пользователя |
userId | string | Да | ID пользователя для добавления в группу |
| Параметр | Тип | Описание |
|---|
groupId | string | ID группы |
userId | string | ID пользователя, добавленного в группу |
added | boolean | Был ли пользователь добавлен |
success | boolean | Статус успеха операции |
Удалить пользователя из группы в вашей организации Okta
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
groupId | string | Да | ID группы для удаления пользователя |
userId | string | Да | ID пользователя для удаления из группы |
| Параметр | Тип | Описание |
|---|
groupId | string | ID группы |
userId | string | ID пользователя, удаленного из группы |
removed | boolean | Был ли пользователь удален |
success | boolean | Статус успеха операции |
Список всех членов конкретной группы в вашей организации Okta
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Okta для аутентификации |
domain | string | Да | Домен Okta (например, dev-123456.okta.com) |
groupId | string | Да | ID группы для списка членов |
limit | number | Нет | Максимальное количество членов для возврата (по умолчанию: 1000, максимум: 1000) |
| Параметр | Тип | Описание |
|---|
members | array | Массив объектов пользователей-членов группы |
↳ id | string | ID пользователя |
↳ status | string | Статус пользователя |
↳ firstName | string | Имя |
↳ lastName | string | Фамилия |
↳ email | string | Адрес электронной почты |
↳ login | string | Логин |
↳ mobilePhone | string | Мобильный телефон |
↳ title | string | Должность |
↳ department | string | Отдел |
↳ created | string | Временная метка создания |
↳ lastLogin | string | Временная метка последнего входа |
↳ lastUpdated | string | Временная метка последнего обновления |
↳ activated | string | Временная метка активации |
↳ statusChanged | string | Временная метка изменения статуса |
count | number | Количество возвращенных членов |
success | boolean | Статус успеха операции |