Trang này dành cho các nhà phát triển. Nhập vào của tổ chức của bạn là tiêu chuẩn OAuth 2. 0 và kết nối OpenID cung cấp, vì vậy bất kỳ ứng dụng hay công cụ nào cũng có thể đăng nhập với Kamo tài khoản của họ và, với sự cho phép của họ, làm việc với Kamo dữ liệu của họ thông qua API và máy chủ Kamo MCP. Không có gì ở đây đặc biệt cho một nhà cung cấp hay một loại ứng dụng.
Trước khi bắt đầu
- Một người quản trị mở Thiết lập, thì An ninh, Danh tính & Đăng nhập, Ứng dụng kết nối, và kết nối ứng dụng của bạn (xem Kết nối một ứng dụngHọ có một Số ID khách hàng, and for a website a Khách hàng bí mật, chỉ xuất hiện một lần.
- Ứng dụng của anh đọc mọi thứ khác từ địa chỉ phát hiện trên thẻ của ứng dụng, ví dụ
https://login.yourcompany.com/.well-known/openid-configurationCác tổ chức không có địa chỉ web riêng có một nhưhttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configurationMọi địa chỉ khác trên trang này đều bắt đầu bằng chữ đó nhà phát hành.
Quyền truy cập
Một ứng dụng yêu cầu quyền với scope. Quyền đăng nhập là openid (luôn luôn cần thiết), profile, email, phone, kamo.org, kamo.roles và offline_access (giữ kết nối với một token cập nhật).
Quyền truy cập dữ liệu dưới đây cho phép một ứng dụng sử dụng API thay mặt cho ai đó. Mỗi quyền đại diện cho Kamo quyền mà người đó đã có. Một ứng dụng không bao giờ có thể làm nhiều hơn những gì người dùng có thể làm trong Kamo: khi một ký hiệu được phát hành nó chỉ mang theo quyền truy cập dữ liệu mà người đó có Kamo quyền truy cập lúc đó, và mỗi cuộc gọi sẽ được kiểm tra lại với những gì họ có lúc đó. Việc xóa không bao giờ có sẵn cho một ứng dụng.
Phạm vi | Điều nó cho phép | Kamo quyền cần thiết (bất kỳ) |
|---|---|---|
| Đọc danh bạ và chi tiết của chúng | Xem liên lạc |
| Tạo liên hệ và chỉnh sửa chi tiết của họName | Tạo liên hệ, Sửa liên hệ |
| Đọc những đầu mối mà anh có thể thấy, với tình trạng và lịch sử của chúng | Xem dẫn |
| Tạo, chỉnh sửa và di chuyển các lead qua đường ốngName | Tạo dẫn, sửa dẫn, di chuyển giai đoạn dẫn |
| Đọc lịch và các sự kiện của nóName | Xem lịch |
| Tạo và thay đổi sự kiện trong lịch của bạn | Xem lịch |
| Đọc các hộp thư bạn có thể mở trong Kamo | Truy cập thư |
| Viết và gửi thư từ hộp thư bạn có thể dùng | Truy cập thư |
| Đọc ghi chú và danh sách kiểm tra của bạn | Xem ghi chú, xem nhiệm vụ |
| Tạo và chỉnh sửa ghi chú và danh sách kiểm tra | Tạo ghi chú, sửa ghi chú |
| Đọc tài liệu và tập tin có thể mở | Xem tài liệu |
| Tải lên tài liệu và chỉnh sửa chúng | Tạo tài liệu, sửa tài liệu |
| Đọc các bài viết cơ sở kiến thức của tổ chức của bạn | Xem bài viết KB |
| Tạo và chỉnh sửa bài viết cơ sở kiến thức | Tạo bài KB, sửa bài KB |
| Đọc các cuộc họp và chi tiết của chúng | Xem cuộc họp |
| Lập lịch, thay đổi và bắt đầu cuộc họp | Bắt đầu cuộc họp, Quản lý cuộc họp |
Danh sách tương tự, luôn luôn hiện tại, là tại https://api.<your domain>/api/security/oidc/scopes. Và write quyền cũng cho phép ứng dụng đọc cùng loại dữ liệu.
Ứng dụng chỉ có thể yêu cầu các quyền mà nó đã được cấp. Người quản trị của bạn chọn chúng khi kết nối ứng dụng: những quyền đăng nhập dưới What It Can See, những dữ liệu dưới Làm việc với dữ liệu Kamo, một Xem đi Và một Thay đổi chuyển đổi mỗi loại dữ liệu, mỗi loại cho thấy Kamo quyền cần thiết. Hỏi chúng bật chính xác phạm vi mà bạn yêu cầu; nếu hỏi một trong số đó thì ứng dụng sẽ không được cho phép invalid_scope.
Nhập ai đó vào (Mật khẩu ủy quyền với PKCE)
Gửi trình duyệt của người đó đến địa chỉ xác nhận với thách thức 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=S256Họ đăng nhập, xem ứng dụng của bạn yêu cầu gì bằng những từ đơn giản, và nhấn Cho phép. Địa chỉ chuyển tiếp của bạn nhận code, state và issĐổi mật khẩu thành token:
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_VERIFIERCác ứng dụng không thể giữ bí mật (trang duy nhất, di động, máy tính, dòng lệnh) gửi client_id=YOUR_CLIENT_ID thay vì -uCâu trả lời là... access_token (một biểu tượng của người mang), id_token (người ký tên), refresh_token (chỉ với offline_access) và scope (điều mà biểu tượng thực sự mang theo).
Gọi API
Gửi mã truy cập đến địa chỉ API của tổ chức của bạn:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 với
WWW-Authenticate: Bearer error="invalid_token": ký hiệu đã hết hạn, bị hủy bỏ, hoặc người đó không còn quyền truy cập nữa. Cập nhật nó hoặc đăng nhập lại. - 403 với
error="insufficient_scope", scope="contacts.write": ký hiệu không mang theo quyền cần thiết cho địa chỉ đó. Hỏi về nó khi đăng nhập. - Đọc (
GET) cầnreadcho phép loại dữ liệu đó; bất cứ thứ gì thay đổi dữ liệu cầnwrite.
Cho ứng dụng của bạn tự đăng ký
Nếu người quản trị bật Cho phép ứng dụng tự kết nối (xem bài viết đó), một ứng dụng có thể đăng ký mà không cần ai gõ vào, sử dụng yêu cầu đăng ký tiêu chuẩn (RFC 7591). Địa chỉ trong tài liệu phát hiện là 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" }'Câu trả lời là của anh client_id (và một client_secret cho các ứng dụng giữ một) và kamo_status. Đang chờ có nghĩa là người quản trị phải chấp thuận nó trong Connected Apps trước khi ai đó có thể đăng nhập; cho đến khi đó, đăng nhập sẽ hiển thị "This app is waiting for approval". Khi đăng ký tắt, địa chỉ trả lời 404.
Kết nối một trợ lý AI hoặc chương trình khách MCP
Máy phục vụ MCP Kamo đang ở https://api.yourcompany.com/mcp. Bất kỳ máy khách MCP nào hỗ trợ quyền truy cập MCP có thể kết nối: 401 với WWW-Authenticate tiêu đề chỉ vào https://api.yourcompany.com/.well-known/oauth-protected-resource/mcp, mà đặt tên đăng nhập của tổ chức của bạn là máy phục vụ ủy quyền. Sau đó máy khách tự đăng ký (nếu cho phép) hoặc dùng một ID máy khách mà người quản trị đã cho bạn, đăng nhập người đó như trên, và gửi Authorization: Bearer ACCESS_TOKEN trên mỗi yêu cầu MCP. công cụ nó có thể sử dụng chính xác là những thứ mà quyền của người đó và phạm vi của token cho phép.
Truy cập trên TV hay thiết bị
Các thiết bị không có bàn phím sử dụng đăng nhập thiết bị (RFC 8628). Ứng dụng cần TV hay thiết bị nhập, hoặc thiết bị đăng nhập đã bật:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Cho người đó xem user_code (giống như WDJB-MJHT) và verification_uri, sau đó thăm dò mỗi interval giây:
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_IDTiếp tục thăm dò cho đến khi câu trả lời là authorization_pending; on slow_down Cứ đợi thêm 5 giây mỗi lần, mật khẩu có hiệu lực 10 phút.
Khi ai đó rời đi
Gỡ bỏ quyền truy cập của một người trong Kamo sẽ chấm dứt token của họ: API và máy chủ MCP ngừng trả lời cho họ ngay lập tức (trong một phút), và cập nhật thất bại. Người dùng cũng có thể tự gỡ bỏ một ứng dụng trong Hồ sơ của tôi, Ứng dụng có quyền truy cập.
Bài viết liên quan
Các hướng dẫn khác trả lời các câu hỏi gần với câu hỏi này.
Kết nối một ứng dụng
Để kết nối một ứng dụng cần bảy bước ngắn. Mở Thiết lập, thì An ninh, chọn Danh tính & Đăng nhập, thì Ứng dụng kết nối, và nhấn Kết nối một ứng dụngCậu cần nó Quản lý các ứng dụng kết nối Xin lỗi. Không có gì được lưu…
Cho phép ứng dụng tự kết nối
Một số ứng dụng, như AI trợ lý sử dụng MCP và công cụ dòng lệnh, có thể tự kết nối với đăng nhập của tổ chức của bạn thay vì người quản trị gõ vào. Điều này được gọi là đăng ký độngĐúng vậy Tắt trừ khi anh bật nó lên.…
Ứng dụng kết nối
Ứng dụng kết nối cho phép người dùng của bạn đăng nhập vào các trang web và ứng dụng khác, như WordPress, Grafana, Moodle, Nextcloud hoặc trang web của bạn, với tài khoản Kamo mà họ đã có. Nó hoạt động như sau Truy cập…
Ứng dụng có quyền truy cập
Tổ chức của bạn có thể cho phép bạn đăng nhập vào các trang web và ứng dụng khác với tài khoản tổ chức của bạn, chẳng hạn như một blog công ty, bảng điều khiển hoặc một trang đào tạo. Lần đầu tiên bạn làm vậy, ứng dụng…
Tự động cung cấp
Đặt sẵn tự động cho phép nhà cung cấp danh tính của bạn tự động cập nhật Kamo. Một người nào đó được thêm vào nhà cung cấp của bạn xuất hiện trong Kamo, một thay đổi trong chức vụ hoặc bộ phận của họ sẽ theo sau họ, và…
