此页面面向开发人员。 您的组织的登录是标准的 OAuth 2.0 和 OpenID 连接 这样,任何应用程序或工具都可以使用 Kamo 帐户登录,并在他们的许可下,通过 API 和 Kamo MCP 服务器处理他们的 Kamo 数据。 这里没有任何内容是针对某个供应商或某种类型的应用程序的。
在你开始之前
- 管理员打开 设置然后 安全, 身份与登录, 连接的应用程序并连接您的应用(请参阅 连接应用程序他们得到了一个 客户ID, 并为一个网站 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 中打开的邮箱 | 访问邮件 |
| 从您可以使用的邮箱编写和发送电子邮件 | 访问邮件 |
| 阅读您的笔记和清单 | 查看笔记,查看任务 |
| 创建和编辑笔记和清单 | 创建笔记,编辑笔记 |
| 阅读您可以打开的文档和文件 | 查看文档 |
| 上传文档并编辑它们 | 创建文档,编辑文档 |
| 阅读您组织的知识库文章 | 查看 KB 文章 |
| 创建和编辑知识库文章 | 创建知识库文章,编辑知识库文章 |
| 阅读您的会议及其详细信息 | 查看会议 |
| 安排、更改和启动会议 | 启动会议,管理会议 |
相同的列表,总是当前的,是在 https://api.<your domain>/api/security/oidc/scopesA. 联合国人类住区规划署 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不能保密的应用程序(单页、移动、桌面、命令行) send 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 客户端
Kamo MCP 服务器位于 https://api.yourcompany.com/mcp任何支持 MCP 授权的 MCP 客户端都可以连接:在第一次调用时,它会获得 401 具有 WWW-Authenticate 标题指向 https://api.yourcompany.com/.well-known/oauth-protected-resource/mcp然后,客户端会自行注册(如果允许)或使用管理员给您的客户端 ID,按上面的方式登录该用户,并发送 Authorization: Bearer ACCESS_TOKEN 它可以使用的工具正是该用户的权限和令牌的作用域所允许的工具。
在电视或设备上登录
无键盘的设备使用设备登录(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 代码有效期为 10 分钟。
当有人离开
在 Kamo 中删除某人的访问权限会终止其令牌:API 和 MCP 服务器会立即停止为其响应(在一分钟内 ) , 并且刷新会失败 我的个人资料, 有访问权限的应用程序.
相关文章
其他指南回答的问题接近这个.
连接应用程序
连接应用程序需要七个简单步骤。 打开 设置然后 安全, 选择 身份与登录然后 连接的应用程序, 然后按 连接应用程序你需要的东西 管理连接的应用程序 请允许 没有什么是保存,直到 连接应用程序 在步骤 6 中,并且在某人登录到应用程序之前不会影响任何人。 连接应用程序 在步骤 2、4 和 6 的右侧,您可以看到用户首次登录时将看到的页面图片,该图片是根据您的选择绘制的,并随您的操作而变化。 步骤 1: 选择要连接的设备 选择产品:…
让应用程序自行连接
某些应用(例如使用 MCP 和命令行工具的 AI 助手)可以自行连接到您单位的登录,而不需要管理员键入。 这称为 动态注册是的 关闭 除非你打开它。 哪里是 开放 设置然后 安全, 选择 身份与登录然后 连接的应用程序你需要的东西 管理连接的应用程序 您的组织的登录提供程序必须打开。 三个选择 关闭 (默认值 ) : 应用无法自我注册。 注册地址不存在,并且回复"未找到 " 。 先问我: 任何应用程序都可以注册,但它会等待…
连接的应用程序
连接应用程序 让您的用户可以使用他们已经拥有的 Kamo 帐户登录其他网站和应用程序,例如 WordPress 、 Grafana 、 Moodle、Nextcloud 或您自己的网站 用 Google 登录一个帐户和一个密码适用于所有内容,当某人离开您的组织时,他们也无法再登录任何应用程序。 连接的应用程序 开放 设置然后 安全, 选择 身份与登录然后 连接的应用程序你需要的东西 管理连接的应用程序 管理员已经拥有此权限。…
有访问权限的应用程序
您的组织可以允许您使用组织帐户登录其他网站和应用程序,例如公司博客、仪表板或培训网站。 第一次登录时,应用程序可能会询问它可以看到什么,您可以选择 允许 或 不允许. 有访问权限的应用程序 您允许的每个应用程序都会在您的个人资料中列出:打开您的图片, 我的个人资料回到顶部 准入 只有您可以在自己的个人资料中看到此卡片。 每个应用程序都会显示其名称和徽标、您上次使用它的时间以及您允许它的时间。 应用程序可以看到什么 下 它能看见…
自动配置
自动配置允许您的身份提供程序自动更新 Kamo。 您的提供程序中添加的用户会在 Kamo 中显示,其职称或部门的更改会随之显示,而在您的提供程序中删除的用户会在 Kamo 中终止 国际货币基金组织. 自动配置 开放 设置然后 安全, 选择 身份与登录然后 供应你需要的东西 管理身份提供商 Provisioning 通过身份提供程序连接进行,因此请先添加一个(请参阅 身份提供商如果你有多个,请在顶部选择一个。 Provisioning…
