Эта страница предназначена для разработчиков. Вход в систему вашей организации является стандартным OAuth 2.0 и OpenID Connect поставщика, так что любое приложение или инструмент может войти ваши люди с их Kamo учетных записей и, с их разрешения, работать с их Kamo данных через API и Kamo MCP сервера. Ничто здесь не является специфическим для одного поставщика или одного вида приложения.
Прежде чем начать
- Администратор открывает Настройки, то Безопасность, Идентификация и вход в систему, Подключенные приложения, и соединяет ваше приложение (см Подключить приложениеОни получают идентификатор клиента, а для веб-сайтаa секретный клиент, показан один раз.
- Ваше приложение читает все остальное из адрес обнаружения на карте приложения, например
https://login.yourcompany.com/.well-known/openid-configuration. Организации, не имеющие собственного веб-адреса, имеют такой, какhttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configuration. Каждый другой адрес на этой странице начинается с того же эмитент.
Разрешения (области)
Приложение просит разрешения с scope. Разрешения на вход openid (всегда необходимо), profile, email, phone, kamo.org, kamo.roles и offline_access (оставайтесь подключенными с обновляющимся токеном).
Приведенные ниже разрешения на доступ к данным позволяют приложению использовать API от имени другого пользователя. Каждое из них означает Kamo разрешений, которыми этот пользователь уже обладает. Приложение никогда не сможет сделать больше, чем человек может сделать в Kamo самостоятельно: когда токен выдается, он содержит только те разрешения на данные, Kamo разрешений на которые у человека есть в данный момент, и каждый вызов проверяется снова на соответствие тому, что у него есть в данный момент. Приложение никогда не может удалять.
Сфера охвата | Что она позволяет | Kamo необходимое разрешение (любое из) |
|---|---|---|
| Читать контакты и их данные | Посмотреть контакты |
| Создать контакты и редактировать их данные | Создание контактов, редактирование контактов |
| Читайте потенциальных клиентов, которых вы видите, с их статусом и историей | Посмотреть Leads |
| Создание потенциальных клиентов, их редактирование и перемещение по каналу | Создание потенциальных клиентов, редактирование потенциальных клиентов, перемещение этапа потенциальных клиентов |
| Читайте свой календарь и его события | Календарь |
| Создание и изменение событий в календаре | Календарь |
| Читать почтовые ящики, которые вы можете открыть в Kamo | Почта доступа |
| Написать и отправить электронную почту из почтовых ящиков, которые вы можете использовать | Почта доступа |
| Читайте свои заметки и контрольные списки | Просмотр Заметок, Просмотр Заданий |
| Создание и редактирование заметок и контрольных списков | Создание заметок, редактирование заметок |
| Читать документы и файлы, которые вы можете открыть | Посмотреть документы |
| Загрузить документы и редактировать их | Создание и редактирование документов |
| Читать статьи базы знаний организации | Просмотр KB Статьи |
| Создание и редактирование статей базы знаний | Создание статей KB, редактирование статей KB |
| Читать ваши встречи и их детали | Смотреть встречи |
| Расписание, изменение и начало совещаний | Начало встречи, управление встречей |
Тот же список, всегда актуальный, находится на https://api.<your domain>/api/security/oidc/scopes. А write разрешение также позволяет приложению читать данные того же типа.
Приложение может запрашивать только те разрешения, которые ему были даны. Ваш администратор выбирает их при подключении приложения: те, которые нужны для входа в систему под Что он может видеть, данные по которым Работа с Kamo данными, один Зеркало и один Изменение по типу данных, каждый из которых показывает Kamo разрешений, которые ему нужны. Попросите их включить именно те области, которые вы запрашивали; запрос одной из областей, которая не была предоставлена приложению, завершается с ошибкой invalid_scope.
Вход в систему (авторизационный код с PKCE)
Отправить браузер пользователя на адрес авторизации с вызовом PKCE:
https://login.yourcompany.com/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID
&redirect_uri=https%3A%2F%2Fapp.example.com%2Fcallback&scope=openid%20profile%20contacts.read%20offline_access
&state=RANDOM&code_challenge=BASE64URL_SHA256_OF_VERIFIER&code_challenge_method=S256Они входят, видят, что ваше приложение просит в простых словах, и нажмите Разрешить. Ваш адрес перенаправления получает code, state и iss. Обменяйте код на жетоны:
curl -X POST https://login.yourcompany.com/oauth/token \
-u YOUR_CLIENT_ID:YOUR_CLIENT_SECRET \
-d grant_type=authorization_code -d code=THE_CODE \
-d redirect_uri=https://app.example.com/callback -d code_verifier=THE_VERIFIERПриложения, которые не могут хранить секрет (одна страница, мобильные, настольные, командная строка) отправить client_id=YOUR_CLIENT_ID вместо -u. Ответ access_token (токен носителя), id_token (подписавшийся), refresh_token (только с offline_access) и scope (что на самом деле несет жетон).
Вызов API
Отправьте токен доступа на адрес API вашей организации:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 с
WWW-Authenticate: Bearer error="invalid_token": срок действия токена истек, он был отозван, или у пользователя больше нет доступа. Обновите его или снова войдите в систему. - 403 с
error="insufficient_scope", scope="contacts.write": токен не содержит разрешения, которое требуется адресу. Запросить его при входе в систему. - Рединг (
GET) требуетсяreadразрешения на использование данных такого рода; что-либо, что изменяет потребности в данныхwrite.
Пусть приложение зарегистрирует себя само
Если администратор включил Разрешить приложениям самостоятельно подключаться (см. эту статью), приложение может зарегистрироваться без ввода адреса, используя стандартный запрос на регистрацию (RFC 7591). Адрес в документе обнаружения registration_endpoint:
curl -X POST https://login.yourcompany.com/oauth/register -H "Content-Type: application/json" -d '{
"client_name": "My Tool", "redirect_uris": ["http://127.0.0.1:33418/callback"],
"token_endpoint_auth_method": "none", "grant_types": ["authorization_code", "refresh_token"],
"scope": "openid contacts.read leads.read offline_access" }'Ответ есть у вас client_id (и client_secret для приложений, которые держат один) и kamo_status. В ПРОЦЕССЕ РАССМОТРЕНИЯ означает, что администратор должен утвердить его в Подключенные приложения, прежде чем кто-то может войти; до этого вход в показывает "Это приложение ожидает утверждения" 404.
Подключить AI Помощника или Клиента MCP
MCP-сервер Kamo находится на https://api.yourcompany.com/mcp. Любой MCP-клиент, поддерживающий MCP-авторизацию, может подключаться: при первом вызове он получает 401 с WWW-Authenticate заголовок, указывающий на https://api.yourcompany.com/.well-known/oauth-protected-resource/mcp, который именует вход вашей организации в качестве сервера авторизации. Затем клиент регистрирует себя (если это разрешено) или использует идентификатор клиента, предоставленный вам администратором, входит в систему, как описано выше, и отправляет Authorization: Bearer ACCESS_TOKEN на каждый запрос MCP. Средства, которые он может использовать, точно такие же, какие разрешены разрешениями пользователя и областями токена.
Войти на телевизоре или устройстве
Устройства без клавиатуры используют вход в устройство (RFC 8628) ТВ или устройство введите, или вход устройства включен:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Покажите человеку user_code (как WDJB-MJHT) и verification_uri, а затем проводить опрос каждые interval секунды:
curl -X POST https://login.yourcompany.com/oauth/token -d grant_type=urn:ietf:params:oauth:grant-type:device_code \
-d device_code=THE_DEVICE_CODE -d client_id=YOUR_CLIENT_IDПродолжать опросы, пока ответ authorization_pending; один slow_down каждый раз подождите еще 5 секунд. Код действует 10 минут.
Когда кто-то уходит
Если удалить доступ пользователя в Kamo, то это приведет к прекращению действия его токенов: API и MCP-сервер перестанут отвечать на запросы пользователя сразу же (в течение одной минуты), а обновление завершится сбоем Мой профиль, Приложения с доступом.
Похожие статьи
Другие руководства, которые отвечают на вопросы, близкие к этому.
Подключить приложение
Для подключения приложения необходимо выполнить семь простых действий. Открыть Настройки, то Безопасность, выбрать Идентификация и вход в систему, то Подключенные приложения, и нажмите Подключить приложение. Вам нужна…
Разрешить приложениям самостоятельно подключаться
Некоторые приложения, например AI ассистенты, использующие MCP и средства командной строки, могут самостоятельно подключаться к системе входа в организацию вместо того, чтобы администратор вводил их. Это называется…
Подключенные приложения
Подключенные приложения позволяют вашим пользователям войти на другие сайты и приложения, такие как WordPress, Grafana, Moodle, Nextcloud или ваш собственный сайт, с помощью учетной записи Kamo, которой они уже обладают…
Приложения с доступом
Ваша организация может разрешить вам войти в другие веб-сайты и приложения с помощью учетной записи организации, например в корпоративный блог, на информационные панели или на учебный сайт. При первом входе в систему…
Автоматическое обеспечение
Автоматическое предоставление позволяет вашему поставщику удостоверений самостоятельно обновлять Kamo. Кто-то добавляется в вашем поставщике, появляется в Kamo, изменение его должности или отдела следует за ним, а…
