Ta strona jest przeznaczona dla deweloperów. Logowanie w organizacji jest standardem OAuth 2.0 i OpenID Connect Dostawca, więc każda aplikacja lub narzędzie może zalogować się do swoich ludzi z ich Kamo Konta i, za ich pozwoleniem, pracować z ich Kamo Dane za pośrednictwem interfejsu API i Kamo Nic tutaj nie jest specyficzne dla jednego dostawcy lub jednego rodzaju aplikacji.
Zanim zaczniesz
- Administrator otwiera Ustawienia, wtedy Zabezpieczenia, Tożsamość & logowanie, Połączone aplikacje, i łączy się z aplikacją (patrz Podłącz aplikację). Oni dostają ID klienta, a dla strony internetowej a Tajny klient, pokazany raz.
- Twoja aplikacja odczytuje wszystko inne z discovery address Na karcie aplikacji, na przykład
https://login.yourcompany.com/.well-known/openid-configuration. Organizacje bez własnego adresu internetowego mają taki jakhttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configuration. Każdy inny adres na tej stronie zaczyna się od tego samego emitent.
Uprawnienia (zakresy)
Aplikacja prosi o uprawnienia z scope. Uprawnienia do logowania są openid (zawsze potrzebne), profile, email, phone, kamo.org, kamo.roles oraz offline_access (pozostać połączonym za pomocą tokenu odświeżania).
Poniższe uprawnienia do danych umożliwiają aplikacji korzystanie z interfejsu API w czyimś imieniu.Każde z nich oznacza Kamo uprawnień, które dana osoba już ma. Aplikacja nigdy nie może zrobić więcej niż osoba mogłaby zrobić w Kamo: gdy token jest wydawany, przenosi tylko te uprawnienia do danych, których Kamo uprawnienia posiada dana osoba w danym momencie, a każde połączenie jest ponownie sprawdzane pod kątem tego, co posiada w tym momencie.
Zakres | Na co pozwala | Kamo uprawnienia, których potrzebuje (dowolne) |
|---|---|---|
| Odczyt kontaktów i ich szczegółów | Zobacz kontakty |
| Twórz kontakty i edytuj ich dane | Tworzenie kontaktów, edycja kontaktów |
| Przeczytaj leady, które możesz zobaczyć, z ich statusem i historią | Zobacz leady |
| Twórz potencjalnych klientów, edytuj je i przesuń je przez lejek | Tworzenie leadów, edycja leadów, przenoszenie etapu leadów |
| Czytanie kalendarza i jego wydarzeń | Zobacz kalendarz |
| Tworzenie i zmienianie zdarzeń w kalendarzu | Zobacz kalendarz |
| Czytaj skrzynki pocztowe, które możesz otworzyć w Kamo | Access Mail |
| Pisanie i wysyłanie wiadomości e-mail ze skrzynek pocztowych, których możesz używać | Access Mail |
| Czytanie notatek i list kontrolnych | Zobacz notatki, Zobacz zadania |
| Twórz i edytuj notatki i listy kontrolne | Tworzenie notatek, edycja notatek |
| Przeczytaj dokumenty i pliki, które możesz otworzyć | Zobacz dokumenty |
| Przesyłaj dokumenty i edytuj je | Twórz dokumenty, edytuj dokumenty |
| Przeczytaj artykuły z bazy wiedzy organizacji | Zobacz artykuły KB |
| Tworzenie i edytowanie artykułów bazy wiedzy | Tworzenie artykułów KB, edycja artykułów KB |
| Czytaj swoje spotkania i ich szczegóły | Zobacz spotkania |
| Planowanie, zmienianie i rozpoczynanie spotkań | Rozpocznij spotkanie, zarządzaj spotkaniami |
Ta sama lista, zawsze aktualna, znajduje się pod adresem https://api.<your domain>/api/security/oidc/scopes. A write To uprawnienie pozwala aplikacji na odczyt tego samego rodzaju danych.
Aplikacja może prosić tylko o uprawnienia, które zostały jej przyznane. Administrator wybiera je podczas łączenia aplikacji. Uprawnienia logowania znajdują się w sekcji Co może widzieć, dane te pod Praca z danymi Kamo, jeden See I jeden Zmiana Przełącznik dla każdego rodzaju danych, z których każdy pokazuje Kamo Poproś ich, aby włączyli dokładnie te zakresy, o które prosisz; prośba o jeden, którego aplikacja nie otrzymała, nie powiedzie się z invalid_scope.
Zaloguj kogoś (kod autoryzacyjny z PKCE)
Wyślij przeglądarkę osoby na adres autoryzacyjny z wyzwaniem 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=S256Zalogują się, zobaczą, o co prosi Twoja aplikacja w prostych słowach i naciszą Allow. Twój adres przekierowania otrzyma code, state oraz iss. Zamień kod na żetony:
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_VERIFIERAplikacje, które nie mogą zachować tajemnicy (pojedyncza strona, urządzenie mobilne, komputer, wiersz poleceń) client_id=YOUR_CLIENT_ID zamiast -u. Odpowiedź ma access_token (token nosiciela), id_token (który się zarejestrował), refresh_token (tylko z offline_access) oraz scope (co tak naprawdę nosi token).
Wywołanie API
Wyślij token dostępu na adres API Twojej organizacji:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 z
WWW-Authenticate: Bearer error="invalid_token": token wygasł, został odwołany lub dana osoba nie ma już do niego dostępu. Odśwież go lub zaloguj się ponownie. - 403 z
error="insufficient_scope", scope="contacts.write": token nie posiada uprawnień, których potrzebuje adres. Zapytaj o nie podczas logowania. - Reading (
GET) potrzebuje pomocyreadzezwolenie na ten rodzaj danych; wszystko, co zmienia potrzeby danychwrite.
Pozwól aplikacji zarejestrować się samodzielnie
Jeśli administrator włączył Pozwól aplikacjom łączyć się same (zobacz ten artykuł), aplikacja może się zarejestrować bez konieczności wpisywania jej przez kogokolwiek, używając standardowego żądania rejestracji (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" }'Odpowiedź jest prosta client_id (i client_secret dla aplikacji, które zachowują jeden) i kamo_status. Oczekujące Oznacza to, że administrator musi zatwierdzić ją w aplikacji Connected Apps, zanim ktokolwiek będzie mógł się zalogować; do tego czasu po zalogowaniu wyświetlany jest komunikat „Ta aplikacja czeka na zatwierdzenie” 404.
Podłącz AI asystenta lub klienta MCP
Serwer MCP Kamo znajduje się na https://api.yourcompany.com/mcp. Każdy klient MCP obsługujący autoryzację MCP może się połączyć: przy pierwszym wywołaniu otrzymuje 401 z WWW-Authenticate Nagłówek wskazujący na https://api.yourcompany.com/.well-known/oauth-protected-resource/mcpNastępnie klient zarejestruje się (jeśli jest to dozwolone) lub użyje identyfikatora klienta podanego przez administratora, zaloguje osobę, jak opisano powyżej, i wyśle zapytanie do serwera autoryzacyjnego, aby uzyskać dostęp do serwera autoryzacji Authorization: Bearer ACCESS_TOKEN Narzędzia, których może użyć, są dokładnie takie, na jakie pozwalają uprawnienia osoby i zakresy tokenu.
Zaloguj się na telewizorze lub urządzeniu
Urządzenia bez klawiatury korzystają z logowania urządzenia (RFC 8628). Aplikacja wymaga TV lub urządzenie Wpisz lub włącz logowanie na urządzeniu:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Pokaż tej osobie user_code (podobnie jak WDJB-MJHT) oraz verification_uri, a następnie odpytywać co interval sekund:
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_IDKontynuuj głosowanie, dopóki odpowiedź jest authorization_pending; on slow_down Za każdym razem czekaj o 5 sekund dłużej. Kod działa przez 10 minut.
When Someone Leaves
Usunięcie dostępu osoby w Kamo powoduje zakończenie jej tokenów: interfejs API i serwer MCP przestają odpowiadać na ich prośbę natychmiast (w ciągu minuty), a odświeżenie nie powiedzie się Mój profil użytkownika, Aplikacje z dostępem.
Powiązane artykuły »
Inne przewodniki, które odpowiadają na pytania podobne do tego.
Podłącz aplikację
Połączenie aplikacji zajmuje siedem krótkich kroków. Otwórz Ustawienia, wtedy Zabezpieczenia, wybierz Tożsamość & logowanie, wtedy Połączone aplikacje, i naciśnij Podłącz aplikacjęPotrzebujesz pomocy? Zarządzanie…
Pozwól aplikacjom łączyć się same
Niektóre aplikacje, takie jak AI asystenci korzystający z protokołu MCP i narzędzi wiersza poleceń, mogą samodzielnie łączyć się z logowaniem organizacji, zamiast wpisywania ich przez administratora Rejestracja…
Połączone aplikacje
Połączone aplikacje umożliwiają Twoim użytkownikom logowanie się do innych witryn i aplikacji, takich jak WordPress, Grafana, Moodle, Nextcloud lub Twoja własna witryna, za pomocą konta Kamo, które już posiadają Zaloguj…
Aplikacje z dostępem
Twoja organizacja może pozwolić Ci zalogować się do innych witryn i aplikacji za pomocą konta organizacyjnego, na przykład do bloga firmowego, pulpitu nawigacyjnego lub witryny szkoleniowej. Przy pierwszym logowaniu…
Automatic Provisioning
Automatyczne aprowizowanie pozwala dostawcy tożsamości samodzielnie aktualizować Kamo. Dodanie osoby do dostawcy pojawia się w Kamo, zmiana jej stanowiska lub działu następuje po niej, a usunięcie osoby z dostawcy…
