Diese Seite ist für Entwickler. Die Anmeldung Ihrer Organisation ist eine Standardanmeldung OAuth 2.0 und OpenID Connect Sie können Ihre Mitarbeiter mit ihren Kamo Konten anmelden und mit ihrer Erlaubnis über die API und den Kamo MCP-Server mit ihren Kamo Daten arbeiten.Nichts hier ist spezifisch für einen Anbieter oder eine Art von App.Nothing here is specific to one vendor or one kind of app.
Bevor Sie anfangen
- Ein Administrator öffnet Einstellungen, dann Sicherheit, Identität & Anmeldung, Die verbundenen Apps, und verbindet Ihre App (siehe Eine App verbinden). Sie bekommen eine Client-ID, und für eine Website a Der geheime Kunde, einmal gezeigt.
- Ihre App liest alles andere aus dem Entdeckungsadresse Auf der Karte der App, zum Beispiel
https://login.yourcompany.com/.well-known/openid-configuration. Organisationen ohne eigene Web-Adresse haben eine wiehttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configuration. Jede andere Adresse auf dieser Seite beginnt mit demselben Emittent.
Berechtigungen (Bereiche)
Eine App fragt nach Berechtigungen mit scope. Die Anmeldeberechtigungen sind openid (wird immer gebraucht), profile, email, phone, kamo.org, kamo.roles und offline_access (mit einem Refresh-Token verbunden bleiben).
Die unten aufgeführten Datenberechtigungen ermöglichen es einer App, die API im Namen einer anderen Person zu verwenden.Jede dieser Berechtigungen steht für Kamo Berechtigungen, die die Person bereits besitzt. Eine App kann nie mehr tun, als die Person in Kamo selbst tun könnte: Wenn ein Token ausgegeben wird, trägt es nur die Datenberechtigungen, deren Kamo Berechtigungen die Person gerade hat, und jeder Anruf wird erneut mit dem verglichen, was sie in diesem Moment hat.Eine App kann niemals gelöscht werden.
Scope | Was es ermöglicht | Kamo Berechtigung, die es benötigt (alle) |
|---|---|---|
| Kontakte und deren Details lesen | Kontakte anzeigen |
| Kontakte erstellen und deren Details bearbeiten | Kontakte erstellen, Kontakte bearbeiten |
| Lesen Sie die Leads, die Sie sehen können, mit ihrem Status und Verlauf | Leads anzeigen |
| Leads erstellen, bearbeiten und durch die Pipeline bewegen | Leads erstellen, Leads bearbeiten, Leadphase verschieben |
| Lesen Sie Ihren Kalender und seine Ereignisse | Kalender anzeigen |
| Erstellen und Ändern von Terminen in Ihrem Kalender | Kalender anzeigen |
| Lesen Sie die Postfächer, die Sie in Kamo öffnen können | Zugriff auf Mail |
| Schreiben und senden Sie E-Mails aus den Postfächern, die Sie verwenden können | Zugriff auf Mail |
| Lesen Sie Ihre Notizen und Checklisten | Notizen anzeigen, Aufgaben anzeigen |
| Erstellen und Bearbeiten von Notizen und Checklisten | Notizen erstellen, Notizen bearbeiten |
| Lesen der Dokumente und Dateien, die Sie öffnen können | Dokumente anzeigen |
| Dokumente hochladen und bearbeiten | Dokumente erstellen, Dokumente bearbeiten |
| Wissensdatenbankartikel Ihrer Organisation lesen | KB-Artikel ansehen |
| Wissensdatenbankartikel erstellen und bearbeiten | KB-Artikel erstellen, KB-Artikel bearbeiten |
| Lesen Sie Ihre Meetings und deren Details | Meetings anzeigen |
| Besprechungen planen, ändern und starten | Besprechung starten, Besprechungen verwalten |
Die gleiche Liste, immer aktuell, ist unter https://api.<your domain>/api/security/oidc/scopes. A write Mit dieser Berechtigung kann die App auch die gleiche Art von Daten lesen.
Eine App kann nur die Berechtigungen anfordern, die ihr erteilt wurden und die Ihr Administrator beim Verbinden der App auswählt: die Anmeldeberechtigungen unter Was es sehen kann, die Daten unter Arbeiten mit Kamo Daten, one See und eine Change Schalter pro Art von Daten, die jeweils die Kamo Bitten Sie sie, genau die Scopes einzuschalten, die Sie anfordern; wenn Sie nach einem Scope fragen, der der App nicht erteilt wurde, schlägt dies fehl invalid_scope.
Jemand anmelden (Autorisierungscode mit PKCE)
Senden Sie den Browser der Person mit einer PKCE-Herausforderung an die Autorisierungsadresse:
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=S256Sie melden sich an, sehen, was Ihre App in einfachen Worten anfordert, und drücken Allow. Ihre Weiterleitungsadresse erhält code, state und iss. Tauschen Sie den Code gegen Token ein:
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_VERIFIERApps, die kein Geheimnis bewahren können (einzelne Seite, Mobilgerät, Desktop, Befehlszeile) senden client_id=YOUR_CLIENT_ID anstelle von -u. Die Antwort hat access_token (ein Inhaberzeichen), id_token (der sich angemeldet hat), refresh_token (nur bei Verwendung von offline_access) und scope (was der Token wirklich trägt).
Rufen Sie die API auf
Senden Sie das Zugriffstoken an die API-Adresse Ihrer Organisation:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 mit
WWW-Authenticate: Bearer error="invalid_token": Das Token ist abgelaufen, wurde widerrufen oder die Person hat keinen Zugriff mehr. Aktualisieren Sie es oder melden Sie sich erneut an. - 403 mit
error="insufficient_scope", scope="contacts.write": Das Token enthält nicht die Berechtigung, die die Adresse benötigt. Fragen Sie beim Anmelden danach. - Reading (
GET) braucht diereadErlaubnis dieser Art von Daten; alles, was die Datenbedürfnisse ändertwrite.
Lassen Sie Ihre App sich selbst registrieren
Wenn ein Administrator eingeschaltet hat Lassen Sie Apps sich selbst verbinden (siehe diesen Artikel), kann sich eine App registrieren, ohne dass jemand sie eingibt, indem sie die Standardregistrierungsanforderung (RFC 7591) verwendet.Die Adresse ist im Discovery-Dokument als 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" }'Die Antwort hat Ihre client_id (und ein client_secret für Apps, die eine speichern) und kamo_status. PENDING Dies bedeutet, dass ein Administrator die App in Connected Apps genehmigen muss, bevor sich jemand anmelden kann. Bis dahin wird bei der Anmeldung "Diese App wartet auf Genehmigung" angezeigt. Wenn die Registrierung deaktiviert ist, antwortet die Adresse 404.
Verbinden eines AI-Assistenten oder MCP-Clients
Der MCP-Server Kamo befindet sich unter https://api.yourcompany.com/mcpJeder MCP-Client, der die MCP-Autorisierung unterstützt, kann eine Verbindung herstellen: Beim ersten Aufruf erhält er 401 mit einem WWW-Authenticate Header zeigt auf https://api.yourcompany.com/.well-known/oauth-protected-resource/mcpDer Client registriert sich dann selbst (sofern erlaubt) oder verwendet eine Client-ID, die Ihnen ein Administrator gegeben hat, meldet die Person wie oben beschrieben an und sendet eine E-Mail an den Autorisierungsserver Authorization: Bearer ACCESS_TOKEN Die Werkzeuge, die es verwenden kann, sind genau diejenigen, die die Berechtigungen der Person und die Bereiche des Tokens erlauben.
Auf einem Fernseher oder Gerät anmelden
Geräte ohne Tastatur verwenden die Geräteanmeldung (RFC 8628). Die App benötigt die Fernseher oder Gerät Geben Sie Folgendes ein oder schalten Sie die Geräteanmeldung ein:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Zeigen Sie der Person die user_code (wie WDJB-MJHT) und die verification_uri, dann abfragen alle interval Sekunden:
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_IDHalten Sie die Abstimmung, während die Antwort ist authorization_pending; on slow_down Warten Sie jedes Mal 5 Sekunden länger. Der Code ist 10 Minuten gültig.
When Someone Leaves
Das Entfernen des Zugriffs einer Person in Kamo beendet deren Token: Die API und der MCP-Server antworten sofort nicht mehr auf sie (innerhalb einer Minute) und die Aktualisierung schlägt fehl Mein Profil anzeigen, Apps mit Zugriff.
In Verwandte Artikel
Weitere Anleitungen, die ähnliche Fragen beantworten.
Eine App verbinden
Das Verbinden einer App dauert nur sieben kurze Schritte. Öffnen Einstellungen, dann Sicherheit, wählen Sie Identität & Anmeldung, dann Die verbundenen Apps, und drücken Sie Eine App verbinden. Sie benötigen die…
Lassen Sie Apps sich selbst verbinden
Einige Apps, z. B. AI-Assistenten, die MCP und Befehlszeilentools verwenden, können sich selbst mit der Anmeldung Ihrer Organisation verbinden, anstatt dass ein Administrator sie eingeben muss Die dynamische…
Die verbundenen Apps
Mit Connected Apps können sich Ihre Mitarbeiter mit dem Kamo-Konto, das sie bereits besitzen, bei anderen Websites und Apps anmelden, z. B. WordPress, Grafana, Moodle, Nextcloud oder Ihrer eigenen Website Anmelden mit…
Apps mit Zugriff
Ihre Organisation kann Ihnen erlauben, sich mit Ihrem Organisationskonto bei anderen Websites und Apps anzumelden, z. B. bei einem Unternehmensblog, Dashboards oder einer Schulungswebsite. Wenn Sie dies zum ersten Mal…
Die automatische Bereitstellung
Mit der automatischen Bereitstellung kann Ihr Identitätsanbieter Kamo selbstständig auf dem neuesten Stand halten. Wenn jemand in Ihrem Anbieter hinzugefügt wird, erscheint er in Kamo, eine Änderung der…
