Ця сторінка призначена для розробників. Вхід у систему вашої організації є стандартним З' єднання OAuth 2. 0 і OpenID Програма, що надає доступ до сервера, тобто будь- яка програма або інструмент може ввійти до системи за допомогою облікових записів 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 права доступу (будь-які) |
|---|---|---|
| Читання контактів і їх даних | Перегляд контактів |
| Створення контактів і редагування їх даних | Створення контактів, редагування контактів |
| Читання відомостей, які ви бачите, з їх станом і історією | Переглянути посилання |
| Створення, редагування і пересування лідів по конвеєрі | Створення, редагування та пересування етапів підготовки |
| Читання вашого календаря і його подій | Перегляд календаря |
| Створення і зміна подій у календарі | Перегляд календаря |
| Читати поштові скриньки, які можна відкрити у Kamo | Пошта Access |
| Написання та надсилання електронної пошти з поштових скриньок, якими ви можете користуватися | Пошта Access |
| Читання ваших нотаток і контрольних списків | Перегляд нотаток, перегляд завдань |
| Створення та редагування нотаток та контрольних списків | Створення нотаток, редагування нотаток |
| Читання документів і файлів, які ви можете відкрити | Перегляд документів |
| Вивантаження та редагування документів | Створення та редагування документів |
| Читання статей бази знань вашої організації | Переглянути статті KB |
| Створення і редагування статей бази знань | Створення статей KB, редагування статей KB |
| Читання ваших зустрічей і відомостей про них | Переглянути зустрічі |
| Запланувати, змінити і розпочати зустрічі | Почати зустріч, керувати зустрічами |
Цей же список, завжди поточний, знаходиться на https://api.<your domain>/api/security/oidc/scopesНе вдалося відкрити файл% 1 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, зміна його посади або відділу слідує за цим, а коли…
