Esta página é para desenvolvedores. O login da sua organização é um padrão OAuth 2.0 e OpenID Connect O MCP permite que qualquer aplicativo ou ferramenta faça login com as contas Kamo de seus usuários e, com a permissão deles, trabalhe com os dados Kamo deles por meio da API e do servidor Kamo MCP.Nada aqui é específico a um fornecedor ou a um tipo de aplicativo.
Antes de começar
- Um administrador abre Configurações, então Segurança, Identidade & início de sessão, Aplicativos conectados, e conecta seu aplicativo (veja Conectar um aplicativo). Eles recebem um ID do cliente, e para um site a O cliente secreto, mostrado uma vez.
- Seu aplicativo lê tudo o mais do endereço de descoberta no cartão do aplicativo, por exemplo
https://login.yourcompany.com/.well-known/openid-configuration. Organizações sem seu próprio endereço web têm um comohttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configuration. Todos os outros endereços nesta página começam com o mesmo emissor.
Permissões (escopos)
Um aplicativo pede permissões com scope. As permissões de login são openid (sempre necessário), profile, email, phone, kamo.org, kamo.roles e offline_access (permanecer conectado com um token de atualização).
As permissões de dados abaixo permitem que um aplicativo use a API em nome de alguém.Cada uma representa Kamo permissões que a pessoa já tem. Um aplicativo nunca pode fazer mais do que a pessoa poderia fazer em Kamo eles mesmos: quando um token é emitido, ele carrega apenas as permissões de dados cujas Kamo permissões a pessoa possui no momento, e cada chamada é verificada novamente em relação ao que ela possui nesse momento.A exclusão nunca está disponível para um aplicativo.
Âmbito de aplicação | O que ele permite | Kamo permissão que ele precisa (qualquer um) |
|---|---|---|
| Ler contatos e seus detalhes | Ver os Contactos |
| Crie contatos e edite seus detalhes | Criar contatos, editar contatos |
| Leia os leads que você pode ver, com seu status e histórico | Ver os Leads |
| Crie leads, edite-os e mova-os pelo funil | Criar leads, editar leads, mover o estágio de leads |
| Leia seu calendário e seus eventos | Ver o calendário |
| Criar e alterar eventos no seu calendário | Ver o calendário |
| Leia as caixas de correio que você pode abrir em Kamo | Acesso ao Mail |
| Escreva e envie e-mails a partir das caixas de correio que você pode usar | Acesso ao Mail |
| Leia suas notas e listas de verificação | Ver notas, ver tarefas |
| Criar e editar notas e listas de verificação | Criar notas, editar notas |
| Leia os documentos e ficheiros que pode abrir | Ver os documentos |
| Carregar documentos e editá-los | Criar documentos, editar documentos |
| Leia os artigos da base de conhecimento da sua organização | Ver KB Artigos |
| Criar e editar artigos da base de conhecimento | Criar artigos da base de conhecimento, editar artigos da base de conhecimento |
| Leia suas reuniões e seus detalhes | Ver as reuniões |
| Agendar, alterar e iniciar reuniões | Iniciar reunião, gerenciar reuniões |
A mesma lista, sempre atual, está em https://api.<your domain>/api/security/oidc/scopes. A write Essa permissão também permite que o aplicativo leia o mesmo tipo de dados.
Um aplicativo só pode solicitar as permissões que lhe foram dadas, que são escolhidas pelo administrador ao conectar o aplicativo: as de login em O que ele pode ver, os dados sob Trabalhar com Kamo dados, um Veja e um Mudar por tipo de dados, cada um mostrando o Kamo Peça-lhes que liguem exatamente os escopos que você solicitar; pedir por um que o aplicativo não tenha recebido falha com invalid_scope.
Faça o login de alguém (código de autorização com PKCE)
Envie o navegador da pessoa para o endereço de autorização com um desafio 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=S256Eles entram, veem o que seu aplicativo pede em palavras simples e pressionam Permitir. Seu endereço de redirecionamento recebe code, state e iss. Troque o código por tokens:
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_VERIFIERAplicativos que não podem manter um segredo (página única, móvel, desktop, linha de comando) enviar client_id=YOUR_CLIENT_ID em vez de -u. A resposta tem access_token (um token de portador), id_token (que assinou), refresh_token (apenas com offline_access) e scope (o que o token realmente carrega).
Chamar a API
Envie o token de acesso para o endereço de API da sua organização:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 com
WWW-Authenticate: Bearer error="invalid_token": o token expirou, foi revogado ou a pessoa não tem mais acesso Atualize-o ou faça login novamente. - 403 com
error="insufficient_scope", scope="contacts.write": o token não possui a permissão que o endereço precisa. Peça-o no login. - Reading (Reino Unido)
GET) precisa doreadpermissão desse tipo de dados; qualquer coisa que mude as necessidades de dadoswrite.
Deixe seu aplicativo se registrar sozinho
Se um administrador ativou Deixe que os aplicativos se conectem (veja esse artigo), um aplicativo pode se registrar sem que ninguém o digite, usando a solicitação de registro padrão (RFC 7591).O endereço está no documento de descoberta como 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" }'A resposta tem o seu client_id (e um client_secret para aplicativos que mantêm um) e kamo_status. PENDENTES significa que um administrador deve aprová-lo em Aplicativos conectados antes que qualquer pessoa possa fazer login; até então, o login mostra "Este aplicativo está aguardando aprovação" 404.
Conectar um AI Assistente ou Cliente MCP
O servidor Kamo MCP está em https://api.yourcompany.com/mcp. Qualquer cliente MCP que suporte autorização MCP pode se conectar: em sua primeira chamada ele recebe 401 com um WWW-Authenticate cabeçalho apontando para https://api.yourcompany.com/.well-known/oauth-protected-resource/mcpEm seguida, o cliente se registra (se permitido) ou usa um ID de cliente fornecido por um administrador, faz login da pessoa como acima e envia um e-mail para o servidor de autorização Authorization: Bearer ACCESS_TOKEN As ferramentas que ele pode usar são exatamente as que as permissões da pessoa e os escopos do token permitem.
Faça login em uma TV ou dispositivo
Os dispositivos sem teclado usam o login do dispositivo (RFC 8628). O aplicativo precisa do TV ou dispositivo digite, ou o login do dispositivo está ativado:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Mostre à pessoa o user_code (como WDJB-MJHT) e o verification_uri, em seguida, sondagem a cada interval Segundos:
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_IDContinue votando enquanto a resposta for authorization_pending; on slow_down Aguarde mais 5 segundos de cada vez. O código dura 10 minutos.
Quando alguém sai
Remover o acesso de uma pessoa em Kamo encerra seus tokens: a API e o servidor MCP param de responder para eles imediatamente (dentro de um minuto) e a atualização falha.As pessoas também podem remover um aplicativo elas mesmas em O meu perfil, Aplicativos com acesso.
Outros artigos relacionados
Outros guias que respondem a perguntas semelhantes a esta.
Conectar um aplicativo
A conexão de um aplicativo leva sete etapas curtas. Abrir Configurações, então Segurança, escolher Identidade & início de sessão, então Aplicativos conectados, e pressione Conectar um aplicativo. Você precisa do…
Deixe que os aplicativos se conectem
Alguns aplicativos, como AI assistentes que usam o MCP e ferramentas de linha de comando, podem se conectar ao login da sua organização em vez de um administrador digitando-os registo dinâmico. É Desligado a menos que…
Aplicativos conectados
Os Aplicativos Conectados permitem que seus usuários façam login em outros sites e aplicativos, como WordPress, Grafana, Moodle, Nextcloud ou seu próprio site, com a conta Kamo que eles já têm Iniciar sessão com…
Aplicativos com acesso
Sua organização pode permitir que você entre em outros sites e aplicativos com sua conta da organização, como um blog da empresa, painéis ou um site de treinamento.A primeira vez que você fizer isso, o aplicativo pode…
Provisionamento automático
O provisionamento automático permite que seu provedor de identidade mantenha Kamo atualizado por conta própria. Alguém adicionado ao seu provedor aparece em Kamo, uma alteração no cargo ou departamento deles segue-os e…
