Ukurasa huu ni kwa ajili ya watengenezaji. Kuingia kwa shirika lako ni kawaida OAuth 2.0 na OpenID Kuunganisha mtoa huduma, hivyo programu yoyote au chombo inaweza kujiandikisha watu wako katika na Kamo akaunti zao na, kwa idhini yao, kazi na Kamo data yao kupitia API na Kamo MCP server. Hakuna kitu hapa ni maalum kwa mtoa mmoja au aina moja ya programu.
Kabla ya kuanza
- msimamizi anafungua Mipangilio, basi Usalama, Utambulisho & Kuingia, Programu zilizounganishwa, na inaunganisha programu yako (angalia Kuunganisha Programu). Wao kupata mteja ID, na kwa tovuti a siri mteja, kuonyeshwa mara moja.
- App yako kusoma kila kitu kingine kutoka anwani ya ugunduzi kwenye kadi ya programu, kwa mfano
https://login.yourcompany.com/.well-known/openid-configuration. Mashirika bila anwani yao wenyewe wavuti kuwa na moja kamahttps://login.kamouniverse.com/o/<organization number>/.well-known/openid-configuration. Kila anwani nyingine katika ukurasa huu huanza na kwamba sawa mtoa.
ruhusa (viwango)
App anauliza kwa ajili ya ruhusa na scope. Sign-in ruhusa ni openid (daima inahitajika), profile, email, phone, kamo.org, kamo.roles na offline_access (kukaa kushikamana na refresh ishara).
ruhusa data chini kuruhusu programu kutumia API kwa niaba ya mtu. Kila moja inawakilisha Kamo ruhusa mtu tayari ana. programu kamwe kufanya zaidi ya mtu anaweza kufanya katika Kamo wenyewe: wakati token ni kutolewa inachukua tu idhini data ambaye Kamo idhini mtu ana haki basi, na kila wito ni kuchunguza tena dhidi ya nini wanashikilia katika wakati huo. Kufuta kamwe inapatikana kwa app.
Eneo | Nini inaruhusu | Kamo ruhusa inahitaji (yoyote ya) |
|---|---|---|
| Soma mawasiliano na maelezo yao | Tazama Mawasiliano |
| Kujenga mawasiliano na hariri maelezo yao | Kujenga Mawasiliano, Kuhariri Mawasiliano |
| Soma kuongoza unaweza kuona, na hadhi yao na historia | Tazama Matokeo |
| Kujenga kuongoza, kuhariri yao na kuhamisha yao kwa njia ya bomba | Kujenga Kuongoza, Edit Kuongoza, Kusonga Kuongoza Awamu |
| Soma kalenda yako na matukio yake | Tazama kalenda |
| Kujenga na kubadilisha matukio katika kalenda yako | Tazama kalenda |
| Soma sanduku la barua unaweza kufungua katika Kamo | Kupata barua pepe |
| Kuandika na kutuma barua pepe kutoka mailboxes unaweza kutumia | Kupata barua pepe |
| Soma maelezo yako na orodha ya kudhibiti | Tazama Maelezo, Tazama Kazi |
| Kujenga na hariri maelezo na orodha ya kudhibiti | Kujenga kumbukumbu, Kuhariri kumbukumbu |
| Soma nyaraka na faili unaweza kufungua | Tazama nyaraka |
| kupakia nyaraka na kuhariri yao | Kujenga nyaraka, hariri nyaraka |
| Soma makala ya msingi wa maarifa ya shirika lako | Tazama KB Makala |
| Kujenga na hariri makala maarifa msingi | Kujenga KB Makala, Edit KB Makala |
| Soma mikutano yako na maelezo yao | Tazama Mikutano |
| Ratiba, mabadiliko na kuanza mikutano | Kuanza Mkutano, Kusimamia Mikutano |
orodha hiyo, daima sasa, ni katika https://api.<your domain>/api/security/oidc/scopesMtumiaji write ruhusa pia inaruhusu programu kusoma aina hiyo ya data.
Programu inaweza kuomba tu ruhusa ambazo ilipewa. Msimamizi wako huchagua ruhusa hizo unapounganisha programu: ruhusa za kuingia chini ya Nini inaweza kuona, wale data chini ya Kufanya kazi na Kamo datamoja Tazama na moja Mabadiliko kubadilisha kwa aina ya data, kila moja kuonyesha Kamo ruhusa inahitaji. Kuwauliza kubadilisha juu ya hasa scope wewe ombi; kuuliza kwa ajili ya moja programu haikupewa kushindwa na invalid_scope.
Kujiandikisha Mtu Katika (Uthibitisho Code Na PKCE)
Kutuma mtu browser kwa anwani ya idhini na PKCE changamoto:
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=S256Wao kujiandikisha katika, kuona nini programu yako anauliza kwa maneno rahisi, na bonyeza Zuia. Redirect yako anwani inapokea code, state na iss. Swap kanuni kwa 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_VERIFIERProgramu ambazo haziwezi kuhifadhi siri (wavuti moja, simu, kompyuta, mstari wa amri) client_id=YOUR_CLIENT_ID badala ya -u. Jibu ina access_token Ni mwenye kubeba alama, id_token (ambaye alisaini katika), refresh_token (tu na offline_access) na scope (ni nini alama kweli kubeba).
Kuita API
Kutuma upatikanaji token kwa anwani ya API ya shirika lako:
curl https://api.yourcompany.com/api/contacts -H "Authorization: Bearer ACCESS_TOKEN"- 401 na
WWW-Authenticate: Bearer error="invalid_token": token kumalizika, ilikuwa kufutwa, au mtu hana tena upatikanaji. Refresh au kuingia tena. - 403 na
error="insufficient_scope", scope="contacts.write": ishara haina kubeba ruhusa kwamba anwani mahitaji. Kuuliza kwa ajili yake wakati wa kujiandikisha-in. - Usomaji (
GET) inahitajireadruhusa ya aina hiyo ya data; kitu chochote kwamba mabadiliko ya data mahitajiwrite.
Hebu App yako Kujiandikisha mwenyewe
Kama msimamizi akageuka juu ya Lazima Apps Kujiunga Themselves (angalia makala hiyo), programu inaweza kujiandikisha bila mtu yeyote kuandika katika, kwa kutumia ombi la usajili standard (RFC 7591). anwani ni katika hati ya ugunduzi kama 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" }'Jibu lina yako client_id (na client_secret kwa ajili ya programu kwamba kuweka moja) na kamo_status. Kusubiri ina maana msimamizi lazima kupitisha katika Connected Apps kabla mtu yeyote anaweza kujiandikisha katika; mpaka hapo kujiandikisha katika maonyesho "Hii app ni kusubiri kwa ajili ya idhini". Wakati usajili ni mbali jibu anwani 404.
Kuunganisha AI Msaidizi Au MCP Mteja
MCP server Kamo iko katika https://api.yourcompany.com/mcp. Mteja yoyote MCP kwamba inaunga mkono MCP idhini inaweza kuungana: juu ya wito wake wa kwanza inapata 401 na WWW-Authenticate kichwa kuashiria katika https://api.yourcompany.com/.well-known/oauth-protected-resource/mcp, ambayo majina ya shirika lako kujiandikisha-katika kama server idhini. mteja kisha kujiandikisha mwenyewe (kama kuruhusiwa) au matumizi ya mteja ID msimamizi alikupa, saini mtu katika kama hapo juu, na kutuma Authorization: Bearer ACCESS_TOKEN juu ya kila ombi MCP. zana inaweza kutumia ni hasa wale ruhusa ya mtu na scope ya token kuruhusu.
Ingia kwenye TV au Kifaa
Vifaa bila keyboard kutumia kifaa kuingia (RFC 8628). programu inahitaji TV au kifaa aina, au kifaa kuingia-katika kugeuka juu:
curl -X POST https://login.yourcompany.com/oauth/device_authorization -d client_id=YOUR_CLIENT_ID -d "scope=openid profile"Kuonyesha mtu user_code (kama WDJB-MJHT) na verification_uri, kisha kupiga kura kila interval sekunde:
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_IDKuendelea kupiga kura wakati jibu ni authorization_pending; juu slow_down kusubiri sekunde 5 zaidi kila wakati. kanuni inadumu dakika 10.
Wakati mtu anaondoka
Kuondoa mtu upatikanaji katika Kamo mwisho tokens zao: API na MCP server kuacha kujibu kwa ajili yao mara moja (katika dakika), na kusafisha kushindwa. Watu wanaweza pia kuondoa programu wenyewe katika Wasifu wangu, Programu na Ufikiaji.
Makala zinazohusiana
Miongozo mingine ambayo kujibu maswali karibu na hii moja.
Kuunganisha Programu
Kuunganisha programu huchukua hatua saba fupi. Futa Mipangilio, basi Usalama, kuchagua Utambulisho & Kuingia, basi Programu zilizounganishwa, na bonyeza Kuunganisha Programu. Unahitaji Kusimamia Apps kushikamana Kwa…
Lazima Apps Kujiunga Themselves
Baadhi ya programu, kama vile AI wasaidizi ambao hutumia MCP na zana za mstari wa amri, wanaweza kujiunga na kuingia kwa shirika lako badala ya msimamizi kuandika. Hii huitwa usajili nguvuHakika haya ni maneno ya…
Programu zilizounganishwa
Connected Apps kuruhusu watu wako kuingia katika tovuti nyingine na programu, kama vile WordPress, Grafana, Moodle, Nextcloud au tovuti yako mwenyewe, na Kamo akaunti tayari wana. Inafanya kazi kama Ingia kwa Google,…
Programu na Ufikiaji
Shirika lako linaweza kukuruhusu kuingia kwenye tovuti na programu zingine kwa kutumia akaunti ya shirika lako, kama vile blogu ya kampuni, dashibodi au tovuti ya mafunzo. Mara ya kwanza utakapofanya hivyo, programu…
Kiotomatiki Provisioning
Kutoa moja kwa moja inaruhusu mtoa huduma wako wa utambulisho kuhifadhi Kamo hadi sasa kwa njia yake mwenyewe. Mtu aliyeongezwa katika mtoa huduma wako anaonekana katika Kamo, mabadiliko katika cheo cha kazi yao au…
