Cette page est destinée aux développeurs. La connexion de votre organisation est une connexion standard OAuth 2.0 et OpenID Connect Le fournisseur d'applications peut être un fournisseur de services, de sorte que n'importe quelle application ou n'importe quel outil peut se connecter à vos utilisateurs avec leurs Kamo comptes et, avec leur permission, travailler avec leurs Kamo données via l'API et le serveur Kamo MCP.
Avant de commencer
- Un administrateur ouvre Paramètres, puis Sécurité, Identité & connexion, Les applications connectées, et connecte votre application (voir Connecter une application). Ils obtiennent un ID du client, et pour un site web a Le client secret, montré une fois.
- Votre application lit tout le reste de la Adresse de découverte sur la carte de l'application, par exemple
https://login.yourcompany.com/.well-known/openid-configuration. Les organisations qui n'ont pas leur propre adresse web en ont une commehttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configuration. Toutes les autres adresses de cette page commencent par la même lettre émetteur.
Autorisations (étendues)
Une application demande des autorisations avec scope. Les autorisations de connexion sont openid (toujours nécessaire), profile, email, phone, kamo.org, kamo.roles et offline_access (restez connecté avec un jeton de rafraîchissement).
Les autorisations de données ci-dessous permettent à une application d'utiliser l'API au nom d'une personne, chacune représentant Kamo autorisations dont cette personne dispose déjà. Une application ne peut jamais faire plus que ce que la personne pourrait faire dans Kamo elle-même: lorsqu'un jeton est émis, il ne porte que les autorisations de données dont Kamo les autorisations sont détenues par la personne à ce moment-là, et chaque appel est à nouveau vérifié par rapport à ce qu'elle détient à ce moment-là.
Champ d ' application | Ce qu'il permet | Kamo permission dont il a besoin (n'importe laquelle) |
|---|---|---|
| Lire les contacts et leurs détails | Voir les contacts |
| Créer des contacts et modifier leurs détails | Créer des contacts, Modifier des contacts |
| Lisez les prospects que vous pouvez voir, avec leur statut et leur historique | Voir les Leads |
| Créez des prospects, modifiez-les et déplacez-les dans le pipeline | Créer des prospects, Modifier des prospects, Déplacer l'étape de prospect |
| Lire votre calendrier et ses événements | Voir le calendrier |
| Créer et modifier des événements sur votre calendrier | Voir le calendrier |
| Lire les boîtes aux lettres que vous pouvez ouvrir dans Kamo | Accéder au courrier |
| Rédiger et envoyer des e-mails à partir des boîtes aux lettres que vous pouvez utiliser | Accéder au courrier |
| Lisez vos notes et listes de contrôle | Afficher les notes, afficher les tâches |
| Créer et modifier des notes et des listes de contrôle | Créer des notes, Modifier des notes |
| Lire les documents et fichiers que vous pouvez ouvrir | Voir les documents |
| Télécharger des documents et les modifier | Créer des documents, Modifier des documents |
| Lire les articles de la base de connaissances de votre organisation | Voir les KB Articles |
| Créer et modifier des articles de base de connaissances | Créer des articles KB, Modifier des articles KB |
| Lisez vos réunions et leurs détails | Voir les réunions |
| Planifier, modifier et commencer des réunions | Démarrer une réunion, Gérer des réunions |
La même liste, toujours à jour, se trouve à https://api.<your domain>/api/security/oidc/scopes. A write Cette autorisation permet également à l'application de lire le même type de données.
Une application ne peut demander que les autorisations qui lui ont été accordées et que votre administrateur choisit lors de la connexion de l'application : les autorisations de connexion sous Ce qu'il peut voir, les données sous Travailler avec Kamo données, un Voir et un Changement commutateur par type de données, chacun montrant le Kamo Demandez-leur d'activer exactement les portées que vous demandez; demander une portée que l'application n'a pas obtenue échoue avec invalid_scope.
Signer quelqu'un (code d'autorisation avec PKCE)
Envoyez le navigateur de la personne à l'adresse d'autorisation avec un défi 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=S256Ils se connectent, voient ce que votre application demande en termes simples et appuient sur AutoriserVotre adresse de redirection reçoit code, state et iss. Échangez le code contre des jetons:
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_VERIFIERApplications qui ne peuvent pas garder un secret (page unique, mobile, bureau, ligne de commande) send client_id=YOUR_CLIENT_ID au lieu de -u. La réponse a access_token (un jeton au porteur), id_token (qui a signé), refresh_token (seulement avec offline_access) et scope (ce que le jeton porte réellement).
Appeler l'API
Envoyez le jeton d'accès à l'adresse API de votre organisation:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 avec
WWW-Authenticate: Bearer error="invalid_token": le jeton a expiré, a été révoqué ou la personne n'a plus accès, actualisez-le ou reconnectez-vous. - 403 avec
error="insufficient_scope", scope="contacts.write": le jeton ne porte pas l'autorisation dont l'adresse a besoin. Demandez-le lors de la connexion. - Reading (
GET) a besoin dureadTout ce qui modifie les besoins en données, y compris les donnéeswrite.
Laissez votre application s'enregistrer automatiquement
Si un administrateur a activé Laissez les applications se connecter d'elles-mêmes (voir cet article), une application peut s'enregistrer sans que personne ne la tape, en utilisant la requête d'enregistrement standard (RFC 7591).L'adresse est dans le document de découverte comme 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" }'La réponse a votre nom client_id (et un client_secret pour les applications qui en conservent un) et kamo_status. EN ATTENTE Cela signifie qu'un administrateur doit l'approuver dans Connected Apps avant que quiconque ne puisse se connecter; jusqu'à ce que la connexion affiche "Cette application est en attente d'approbation" 404.
Connecter un assistant ou un client MCP AI
Le serveur Kamo MCP est à https://api.yourcompany.com/mcp. Tout client MCP qui supporte l'autorisation MCP peut se connecter: lors de son premier appel, il obtient 401 avec un WWW-Authenticate En-tête pointant vers https://api.yourcompany.com/.well-known/oauth-protected-resource/mcpLe client s'enregistre ensuite lui-même (s'il est autorisé) ou utilise un ID de client que vous a donné un administrateur, connecte la personne comme ci-dessus, et envoie un message d'autorisation à l'administrateur Authorization: Bearer ACCESS_TOKEN Les outils qu'il peut utiliser sont exactement ceux que les permissions de la personne et les portées du jeton permettent.
Se connecter sur un téléviseur ou un appareil
Les appareils sans clavier utilisent la connexion de l'appareil (RFC 8628) TV ou appareil Tapez, ou la connexion de l'appareil est activée:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Montrez à la personne la user_code (comme WDJB-MJHT) et le verification_uri, puis interroger tous les interval secondes:
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_IDContinuez le sondage tant que la réponse est authorization_pending; on slow_down Attendez 5 secondes de plus à chaque fois. Le code dure 10 minutes.
Quand quelqu'un part
Supprimer l'accès d'une personne dans Kamo met fin à ses jetons : l'API et le serveur MCP cessent de répondre pour eux tout de suite (dans une minute), et l'actualisation échoue Voir mon profil, Applications avec accès.
Les articles connexes
Autres guides qui répondent à des questions proches de celle-ci.
Connecter une application
La connexion d'une application se fait en sept étapes courtes. Ouvrir Paramètres, puis Sécurité, choisir Identité & connexion, puis Les applications connectées, puis appuyez sur Connecter une application. Vous avez…
Laissez les applications se connecter d'elles-mêmes
Certaines applications, telles que les assistants AI qui utilisent MCP et les outils de ligne de commande, peuvent se connecter elles-mêmes à la connexion de votre organisation au lieu d'être saisies par un…
Les applications connectées
Les applications connectées permettent à vos utilisateurs de se connecter à d'autres sites Web et applications, tels que WordPress, Grafana, Moodle, Nextcloud ou votre propre site Web, avec le compte Kamo dont ils…
Applications avec accès
Votre organisation peut vous autoriser à vous connecter à d'autres sites Web et applications avec votre compte d'organisation, tels qu'un blog d'entreprise, des tableaux de bord ou un site de formation.La première fois…
Le provisionnement automatique
Le provisioning automatique permet à votre fournisseur d'identité de maintenir Kamo à jour de manière autonome. Une personne ajoutée dans votre fournisseur apparaît dans Kamo, un changement de son titre de poste ou de…
