Clerk
Управление пользователями, организациями и сессиями в Clerk
Clerk — это комплексная платформа инфраструктуры идентификации, которая помогает управлять пользователями, аутентификацией и сессиями для ваших приложений.
В AACFlow интеграция Clerk позволяет вашим агентам автоматизировать управление пользователями и сессиями с помощью простых в использовании инструментов на основе API. Агенты могут безопасно перечислять пользователей, обновлять профили пользователей, управлять организациями, отслеживать сессии и отзывать доступ непосредственно в вашем рабочем процессе.
С Clerk вы можете:
- Аутентифицировать пользователей и управлять сессиями: Бесшовно контролировать вход, регистрацию и жизненный цикл сессий для ваших пользователей.
- Перечислять и обновлять пользователей: Автоматически получать списки пользователей, обновлять атрибуты пользователей или просматривать детали профилей в рамках задач ваших агентов.
- Управлять организациями и членством: Добавлять или обновлять организации и управлять членством пользователей с ясностью.
- Отслеживать и отзывать сессии: Просматривать активные или прошлые сессии пользователей и немедленно отзывать доступ при необходимости для безопасности.
Интеграция обеспечивает управление вашей пользовательской базой в реальном времени с возможностью аудита — все из AACFlow. Подключенные агенты могут автоматизировать онбординг, применять политики, поддерживать актуальность каталогов и реагировать на события аутентификации или организационные изменения, помогая вам запускать безопасные и гибкие процессы с использованием Clerk в качестве механизма идентификации.
Интегрируйте аутентификацию Clerk и управление пользователями в ваш рабочий процесс. Создавайте, обновляйте, удаляйте и перечисляйте пользователей. Управляйте организациями и их членством. Отслеживайте и контролируйте сессии пользователей.
Перечислить всех пользователей в вашем приложении Clerk с опциональной фильтрацией и пагинацией
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
limit | number | Нет | Количество результатов на странице (например, 10, 50, 100; диапазон: 1-500, по умолчанию: 10) |
offset | number | Нет | Количество результатов для пропуска при пагинации (например, 0, 10, 20) |
orderBy | string | Нет | Поле сортировки с опциональным префиксом +/- для направления (по умолчанию: -created_at) |
emailAddress | string | Нет | Фильтр по адресу электронной почты (например, user@example.com или user1@example.com,user2@example.com) |
phoneNumber | string | Нет | Фильтр по номеру телефона (через запятую для нескольких) |
externalId | string | Нет | Фильтр по внешнему ID (через запятую для нескольких) |
username | string | Нет | Фильтр по имени пользователя (через запятую для нескольких) |
userId | string | Нет | Фильтр по ID пользователя (например, user_2NNEqL2nrIRdJ194ndJqAHwEfxC или через запятую для нескольких) |
query | string | Нет | Поисковый запрос для сопоставления по email, телефону, имени пользователя и именам (например, john или john@example.com) |
| Параметр | Тип | Описание |
|---|
users | array | Массив объектов пользователей Clerk |
↳ id | string | ID пользователя |
↳ username | string | Имя пользователя |
↳ firstName | string | Имя |
↳ lastName | string | Фамилия |
↳ imageUrl | string | URL изображения профиля |
↳ hasImage | boolean | Есть ли у пользователя изображение профиля |
↳ primaryEmailAddressId | string | ID основного адреса электронной почты |
↳ primaryPhoneNumberId | string | ID основного номера телефона |
↳ emailAddresses | array | Адреса электронной почты пользователя |
↳ id | string | ID адреса электронной почты |
↳ emailAddress | string | Адрес электронной почты |
↳ phoneNumbers | array | Номера телефонов пользователя |
↳ id | string | ID номера телефона |
↳ phoneNumber | string | Номер телефона |
↳ externalId | string | ID внешней системы |
↳ passwordEnabled | boolean | Включен ли пароль |
↳ twoFactorEnabled | boolean | Включена ли двухфакторная аутентификация |
↳ banned | boolean | Заблокирован ли пользователь |
↳ locked | boolean | Заблокирован ли пользователь |
↳ lastSignInAt | number | Временная метка последнего входа |
↳ lastActiveAt | number | Временная метка последней активности |
↳ createdAt | number | Временная метка создания |
↳ updatedAt | number | Временная метка последнего обновления |
↳ publicMetadata | json | Публичные метаданные |
totalCount | number | Общее количество пользователей, соответствующих запросу |
success | boolean | Статус успешности операции |
Получить одного пользователя по его ID из Clerk
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
userId | string | Да | ID пользователя для получения (например, user_2NNEqL2nrIRdJ194ndJqAHwEfxC) |
| Параметр | Тип | Описание |
|---|
id | string | ID пользователя |
username | string | Имя пользователя |
firstName | string | Имя |
lastName | string | Фамилия |
imageUrl | string | URL изображения профиля |
hasImage | boolean | Есть ли у пользователя изображение профиля |
primaryEmailAddressId | string | ID основного адреса электронной почты |
primaryPhoneNumberId | string | ID основного номера телефона |
primaryWeb3WalletId | string | ID основного Web3 кошелька |
emailAddresses | array | Адреса электронной почты пользователя |
↳ id | string | ID адреса электронной почты |
↳ emailAddress | string | Адрес электронной почты |
↳ verified | boolean | Подтвержден ли email |
phoneNumbers | array | Номера телефонов пользователя |
↳ id | string | ID номера телефона |
↳ phoneNumber | string | Номер телефона |
↳ verified | boolean | Подтвержден ли телефон |
externalId | string | ID внешней системы |
passwordEnabled | boolean | Включен ли пароль |
twoFactorEnabled | boolean | Включена ли двухфакторная аутентификация |
totpEnabled | boolean | Включен ли TOTP |
backupCodeEnabled | boolean | Включены ли резервные коды |
banned | boolean | Заблокирован ли пользователь |
locked | boolean | Заблокирован ли пользователь |
deleteSelfEnabled | boolean | Может ли пользователь удалить себя |
createOrganizationEnabled | boolean | Может ли пользователь создавать организации |
lastSignInAt | number | Временная метка последнего входа |
lastActiveAt | number | Временная метка последней активности |
createdAt | number | Временная метка создания |
updatedAt | number | Временная метка последнего обновления |
publicMetadata | json | Публичные метаданные (читаемые с фронтенда) |
privateMetadata | json | Приватные метаданные (только для бэкенда) |
unsafeMetadata | json | Небезопасные метаданные (изменяемые с фронтенда) |
success | boolean | Статус успешности операции |
Создать нового пользователя в вашем приложении Clerk
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
emailAddress | string | Нет | Адреса электронной почты для пользователя (через запятую для нескольких) |
phoneNumber | string | Нет | Номера телефонов для пользователя (через запятую для нескольких) |
username | string | Нет | Имя пользователя (должно быть уникальным) |
password | string | Нет | Пароль для пользователя (минимум 8 символов) |
firstName | string | Нет | Имя пользователя |
lastName | string | Нет | Фамилия пользователя |
externalId | string | Нет | Идентификатор внешней системы (должен быть уникальным) |
publicMetadata | json | Нет | Публичные метаданные (объект JSON, читаемый с фронтенда) |
privateMetadata | json | Нет | Приватные метаданные (объект JSON, только для бэкенда) |
unsafeMetadata | json | Нет | Небезопасные метаданные (объект JSON, изменяемые с фронтенда) |
skipPasswordChecks | boolean | Нет | Пропустить проверки валидации пароля |
skipPasswordRequirement | boolean | Нет | Сделать пароль опциональным |
| Параметр | Тип | Описание |
|---|
id | string | ID созданного пользователя |
username | string | Имя пользователя |
firstName | string | Имя |
lastName | string | Фамилия |
imageUrl | string | URL изображения профиля |
primaryEmailAddressId | string | ID основного адреса электронной почты |
primaryPhoneNumberId | string | ID основного номера телефона |
emailAddresses | array | Адреса электронной почты пользователя |
↳ id | string | ID адреса электронной почты |
↳ emailAddress | string | Адрес электронной почты |
↳ verified | boolean | Подтвержден ли email |
phoneNumbers | array | Номера телефонов пользователя |
↳ id | string | ID номера телефона |
↳ phoneNumber | string | Номер телефона |
↳ verified | boolean | Подтвержден ли телефон |
externalId | string | ID внешней системы |
createdAt | number | Временная метка создания |
updatedAt | number | Временная метка последнего обновления |
publicMetadata | json | Публичные метаданные |
success | boolean | Статус успешности операции |
Обновить существующего пользователя в вашем приложении Clerk
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
userId | string | Да | ID пользователя для обновления (например, user_2NNEqL2nrIRdJ194ndJqAHwEfxC) |
firstName | string | Нет | Имя пользователя |
lastName | string | Нет | Фамилия пользователя |
username | string | Нет | Имя пользователя (должно быть уникальным) |
password | string | Нет | Новый пароль (минимум 8 символов) |
externalId | string | Нет | Идентификатор внешней системы |
primaryEmailAddressId | string | Нет | ID подтвержденного email для установки в качестве основного |
primaryPhoneNumberId | string | Нет | ID подтвержденного телефона для установки в качестве основного |
publicMetadata | json | Нет | Публичные метаданные (объект JSON) |
privateMetadata | json | Нет | Приватные метаданные (объект JSON) |
unsafeMetadata | json | Нет | Небезопасные метаданные (объект JSON) |
skipPasswordChecks | boolean | Нет | Пропустить проверки валидации пароля |
| Параметр | Тип | Описание |
|---|
id | string | ID обновленного пользователя |
username | string | Имя пользователя |
firstName | string | Имя |
lastName | string | Фамилия |
imageUrl | string | URL изображения профиля |
primaryEmailAddressId | string | ID основного адреса электронной почты |
primaryPhoneNumberId | string | ID основного номера телефона |
emailAddresses | array | Адреса электронной почты пользователя |
↳ id | string | ID адреса электронной почты |
↳ emailAddress | string | Адрес электронной почты |
↳ verified | boolean | Подтвержден ли email |
phoneNumbers | array | Номера телефонов пользователя |
↳ id | string | ID номера телефона |
↳ phoneNumber | string | Номер телефона |
↳ verified | boolean | Подтвержден ли телефон |
externalId | string | ID внешней системы |
banned | boolean | Заблокирован ли пользователь |
locked | boolean | Заблокирован ли пользователь |
createdAt | number | Временная метка создания |
updatedAt | number | Временная метка последнего обновления |
publicMetadata | json | Публичные метаданные |
success | boolean | Статус успешности операции |
Удалить пользователя из вашего приложения Clerk
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
userId | string | Да | ID пользователя для удаления (например, user_2NNEqL2nrIRdJ194ndJqAHwEfxC) |
| Параметр | Тип | Описание |
|---|
id | string | ID удаленного пользователя |
object | string | Тип объекта (user) |
deleted | boolean | Был ли пользователь удален |
success | boolean | Статус успешности операции |
Перечислить все организации в вашем приложении Clerk с опциональной фильтрацией
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
limit | number | Нет | Количество результатов на странице (например, 10, 50, 100; диапазон: 1-500, по умолчанию: 10) |
offset | number | Нет | Количество результатов для пропуска при пагинации (например, 0, 10, 20) |
includeMembersCount | boolean | Нет | Включить количество участников для каждой организации |
query | string | Нет | Поиск по ID организации, названию или slug (например, Acme Corp или acme-corp) |
orderBy | string | Нет | Поле сортировки (name, created_at, members_count) с префиксом +/- |
| Параметр | Тип | Описание |
|---|
organizations | array | Массив объектов организаций Clerk |
↳ id | string | ID организации |
↳ name | string | Название организации |
↳ slug | string | Slug организации |
↳ imageUrl | string | URL изображения организации |
↳ hasImage | boolean | Есть ли у организации изображение |
↳ membersCount | number | Количество участников |
↳ pendingInvitationsCount | number | Количество ожидающих приглашений |
↳ maxAllowedMemberships | number | Максимально разрешенное количество участников |
↳ adminDeleteEnabled | boolean | Включено ли удаление администратором |
↳ createdBy | string | ID пользователя-создателя |
↳ createdAt | number | Временная метка создания |
↳ updatedAt | number | Временная метка последнего обновления |
↳ publicMetadata | json | Публичные метаданные |
totalCount | number | Общее количество организаций |
success | boolean | Статус успешности операции |
Получить одну организацию по ID или slug из Clerk
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
organizationId | string | Да | ID или slug организации для получения (например, org_2NNEqL2nrIRdJ194ndJqAHwEfxC или my-org-slug) |
| Параметр | Тип | Описание |
|---|
id | string | ID организации |
name | string | Название организации |
slug | string | Slug организации |
imageUrl | string | URL изображения организации |
hasImage | boolean | Есть ли у организации изображение |
membersCount | number | Количество участников |
pendingInvitationsCount | number | Количество ожидающих приглашений |
maxAllowedMemberships | number | Максимально разрешенное количество участников |
adminDeleteEnabled | boolean | Включено ли удаление администратором |
createdBy | string | ID пользователя-создателя |
createdAt | number | Временная метка создания |
updatedAt | number | Временная метка последнего обновления |
publicMetadata | json | Публичные метаданные |
success | boolean | Статус успешности операции |
Создать новую организацию в вашем приложении Clerk
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
name | string | Да | Название организации |
createdBy | string | Да | ID пользователя-создателя, который станет администратором (например, user_2NNEqL2nrIRdJ194ndJqAHwEfxC) |
slug | string | Нет | Slug идентификатор для организации |
maxAllowedMemberships | number | Нет | Максимальная вместимость участников (0 для неограниченного) |
publicMetadata | json | Нет | Публичные метаданные (объект JSON) |
privateMetadata | json | Нет | Приватные метаданные (объект JSON) |
| Параметр | Тип | Описание |
|---|
id | string | ID созданной организации |
name | string | Название организации |
slug | string | Slug организации |
imageUrl | string | URL изображения организации |
hasImage | boolean | Есть ли у организации изображение |
membersCount | number | Количество участников |
pendingInvitationsCount | number | Количество ожидающих приглашений |
maxAllowedMemberships | number | Максимально разрешенное количество участников |
adminDeleteEnabled | boolean | Включено ли удаление администратором |
createdBy | string | ID пользователя-создателя |
createdAt | number | Временная метка создания |
updatedAt | number | Временная метка последнего обновления |
publicMetadata | json | Публичные метаданные |
success | boolean | Статус успешности операции |
Перечислить сессии для пользователя или клиента в вашем приложении Clerk
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
userId | string | Нет | ID пользователя для перечисления сессий (например, user_2NNEqL2nrIRdJ194ndJqAHwEfxC; требуется, если clientId не предоставлен) |
clientId | string | Нет | ID клиента для перечисления сессий (требуется, если userId не предоставлен) |
status | string | Нет | Фильтр по статусу сессии (abandoned, active, ended, expired, pending, removed, replaced, revoked) |
limit | number | Нет | Количество результатов на странице (например, 10, 50, 100; диапазон: 1-500, по умолчанию: 10) |
offset | number | Нет | Количество результатов для пропуска при пагинации (например, 0, 10, 20) |
| Параметр | Тип | Описание |
|---|
sessions | array | Массив объектов сессий Clerk |
↳ id | string | ID сессии |
↳ userId | string | ID пользователя |
↳ clientId | string | ID клиента |
↳ status | string | Статус сессии |
↳ lastActiveAt | number | Временная метка последней активности |
↳ lastActiveOrganizationId | string | ID последней активной организации |
↳ expireAt | number | Временная метка истечения срока |
↳ abandonAt | number | Временная метка отказа |
↳ createdAt | number | Временная метка создания |
↳ updatedAt | number | Временная метка последнего обновления |
totalCount | number | Общее количество сессий |
success | boolean | Статус успешности операции |
Получить одну сессию по ID из Clerk
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
sessionId | string | Да | ID сессии для получения (например, sess_2NNEqL2nrIRdJ194ndJqAHwEfxC) |
| Параметр | Тип | Описание |
|---|
id | string | ID сессии |
userId | string | ID пользователя |
clientId | string | ID клиента |
status | string | Статус сессии |
lastActiveAt | number | Временная метка последней активности |
lastActiveOrganizationId | string | ID последней активной организации |
expireAt | number | Временная метка истечения срока |
abandonAt | number | Временная метка отказа |
createdAt | number | Временная метка создания |
updatedAt | number | Временная метка последнего обновления |
success | boolean | Статус успешности операции |
Отозвать сессию для немедленной инвалидации
| Параметр | Тип | Обязательный | Описание |
|---|
secretKey | string | Да | Секретный ключ Clerk для аутентификации API |
sessionId | string | Да | ID сессии для отзыва (например, sess_2NNEqL2nrIRdJ194ndJqAHwEfxC) |
| Параметр | Тип | Описание |
|---|
id | string | ID сессии |
userId | string | ID пользователя |
clientId | string | ID клиента |
status | string | Статус сессии (должен быть revoked) |
lastActiveAt | number | Временная метка последней активности |
lastActiveOrganizationId | string | ID последней активной организации |
expireAt | number | Временная метка истечения срока |
abandonAt | number | Временная метка отказа |
createdAt | number | Временная метка создания |
updatedAt | number | Временная метка последнего обновления |
success | boolean | Статус успешности операции |
