SCIM провизиясы
SCIM пайдаланушы провизиясын баптау
ScribbleMaps автоматты пайдаланушы провизиясы мен депровизиясы үшін SCIM 2.0 (System for Cross-domain Identity Management) стандартын қолдайды. Бұл сізге пайдаланушыларды Identity Provider (IdP) жүйесінен ScribbleMaps-қа автоматты түрде синхрондауға мүмкіндік береді, осылайша команда мүшелігі ұйymыңыздың анықтамалығымен үйлесімді болады.
SCIM провизиясы team.scribblemaps.com сайтында қолжетімді және мүлдем тегін.
Мазмұны
- SCIM дегеніміз не?
- Бастамас бұрын
- 1-қадам: ScribbleMaps-та SCIM қосу
- 2-қадам: Bearer токенін жасау
- 3-қадам: Identity Provider жүйесін баптау
- 4-қадам: Әдепкі өнімді тағайындауды орнату
- 5-қадам: Тексеру және пайдаланушыларды тағайындау
- Провайдерлерге арналған нұсқаулықтар
- Қолдау көрсетілетін SCIM операциялары
- Пайдаланушының өмірлік циклін басқару
- Ақаулықтарды жою
SCIM дегеніміз не?
SCIM (System for Cross-domain Identity Management) — мыналарды автоматты түрде орындауға мүмкіндік беретін ашық стандарт:
- Пайдаланушыларды провизиялау - IdP жүйесінде пайдаланушылар тағайындалған кезде ScribbleMaps аккаунттарын автоматты түрде жасау
- Пайдаланушыларды жаңарту - Пайдаланушы ақпаратын (аты, электрондық пошта) синхрондалған күйде ұстау
- Пайдаланушыларды депровизиялау - Пайдаланушылар IdP жүйесінен жойылған кезде аккаунттарды автоматты түрде өшіру
- Рөлдерді басқару - Топ мүшелігі арқылы пайдаланушыларды Әкімші немесе Мүше рөлдеріне тағайындау
SCIM SSO (SAML/OIDC) жүйесімен бірге жұмыс істеп, сәйкестендірудің толық өмірлік циклін басқаруды қамтамасыз етеді.
Бастамас бұрын
- SCIM баптау үшін сіз Команда иесі болуыңыз керек
- Identity Provider жүйесінің әкімші консоліне қолжетімділік қажет
- IdP жүйеңіз SCIM 2.0 қолдауы тиіс (Okta, Microsoft Entra ID, OneLogin, JumpCloud және т.б.)
- Ең жақсы пайдаланушы тәжірибесі үшін SCIM алдында SSO баптауды ұсынамыз
1-қадам: ScribbleMaps-та SCIM қосу
- team.scribblemaps.com сайтына кіріңіз
- SCIM Provisioning (сол жақ бүйір тақта) бөліміне өтіңіз
- Enable SCIM ауыстырып-қосқышын ON күйіне қойыңыз
Ескертпе: SCIM толық қосылу үшін алдымен bearer токенін жасау қажет.
2-қадам: Bearer токенін жасау
Bearer токені Identity Provider жүйеңізді ScribbleMaps-та аутентификациялайды.
- SCIM баптаулары бетінде Жасау (Generate Token) түймесін басыңыз
- Токенді бірден көшіріп, қауіпсіз жерде сақтаңыз
Қауіпсіздік бойынша маңызды ескертпелер:
- Токен тек бір рет көрсетіледі - егер оны жоғалтсаңыз, жаңасын жасауыңыз керек
- Бұл токенге құпиясөздей қараңыз - токені бар кез келген адам команда пайдаланушыларын басқара алады
- Токен бұзылған жағдайда оны кез келген уақытта кері қайтарып, қайта жасауға болады
- Токенді кері қайтару жаңа токен бапталғанға дейін барлық SCIM операцияларын бірден тоқтатады
3-қадам: Identity Provider жүйесін баптау
ScribbleMaps-ты IdP жүйесінде SCIM қолданбасы ретінде баптау үшін мына мәліметтерді пайдаланыңыз:
| Параметр | Мән |
|---|---|
| SCIM Base URL | https://api.scribblemaps.com/scim/v2 |
| Аутентификация әдісі | HTTP Header / Bearer Token |
| Authorization Header | Bearer YOUR_TOKEN_HERE |
| Бірегей идентификатор |
userName (электрондық пошта мекенжайы) |
SCIM endpoint-тері бойынша анықтама
| Endpoint | Мақсаты |
|---|---|
/scim/v2/Users |
Пайдаланушыларды провизиялау және басқару |
/scim/v2/Groups |
Рөл/топ мүшелігін басқару |
/scim/v2/ServiceProviderConfig |
SCIM мүмкіндіктері (табу) |
/scim/v2/ResourceTypes |
Қолдау көрсетілетін ресурс түрлері (табу) |
/scim/v2/Schemas |
Пайдаланушы және топ схемалары (табу) |
4-қадам: Әдепкі өнімді тағайындауды орнату (міндетті емес)
SCIM арқылы провизияланған кезде пайдаланушыларға өнім лицензиясын автоматты түрде тағайындауға болады:
- SCIM баптаулары бетінде Default Product Assignment бөлімін табыңыз
- Өнімді таңдаңыз:
- Жоқ - Пайдаланушылар өнімсіз жасалады (кейін қолмен тағайындау керек)
- Көруші - Тек көру мүмкіндігі
- Pro Basic - Стандартты өңдеу функциялары
- Pro Business - Барлық функцияларға толық қолжетімділік
- Сақтау түймесін басыңыз
Ескертпе: Пайдаланушыларға өнім тек бос орындар болған жағдайда ғана тағайындалады. Бос орындар болмаса, пайдаланушы жасалады, бірақ тағайындаусыз қалады.
5-қадам: Тексеру және пайдаланушыларды тағайындау
- Identity Provider жүйесінде SCIM қосылымын тексеру үшін Test Connection функциясын пайдаланыңыз
- IdP жүйесінде ScribbleMaps қолданбасына тест пайдаланушысын тағайындаңыз
- Пайдаланушының ScribbleMaps команда мүшелері тізімінде пайда болғанын тексеріңіз
- Расталғаннан кейін қажет болса қосымша пайдаланушыларды немесе топтарды тағайындаңыз
Провайдерлерге арналған нұсқаулықтар
Okta
- Okta Admin Console ішінде Applications > Browse App Catalog бөліміне өтіңіз
- "SCIM 2.0 Test App (Header Auth)" қолданбасын іздеңіз немесе арнайы SCIM қолданбасын жасаңыз
- Provisioning қойындысына > Configure API Integration бөліміне өтіңіз
- Enable API integration құсбелгісін қойыңыз
- Баптаңыз:
-
SCIM 2.0 Base URL:
https://api.scribblemaps.com/scim/v2 - OAuth Bearer Token: ScribbleMaps SCIM токенін қойыңыз
-
SCIM 2.0 Base URL:
- Тексеру үшін Test API Credentials түймесін басыңыз
- Provisioning > To App бөліміне өтіп, мыналарды қосыңыз:
- Create Users
- Update User Attributes
- Deactivate Users
- Пайдаланушыларды немесе топтарды тағайындау үшін Assignments қойындысына өтіңіз
Microsoft Entra ID (Azure AD)
- Azure Portal ішінде Microsoft Entra ID > Enterprise Applications бөліміне өтіңіз
- ScribbleMaps қолданбасын таңдаңыз (немесе жасаңыз)
- Provisioning > Бастау бөліміне өтіңіз
- Provisioning Mode параметрін Automatic күйіне қойыңыз
- Admin Credentials астында:
-
Tenant URL:
https://api.scribblemaps.com/scim/v2 - Secret Token: ScribbleMaps SCIM токенін қойыңыз
-
Tenant URL:
- Тексеру үшін Test Connection түймесін басыңыз
- Пайдаланушы атрибуттары үшін Mappings баптаңыз
- Provisioning Status параметрін On күйіне қойыңыз
- Пайдаланушыларды тағайындау үшін Users and groups бөліміне өтіңіз
OneLogin
- OneLogin Admin ішінде Applications > Add App бөліміне өтіңіз
- "SCIM Provisioner with SAML (SCIM v2 Core)" немесе соған ұқсас қолданбаны іздеңіз
- Configuration қойындысына өтіңіз
- Баптаңыз:
-
SCIM Base URL:
https://api.scribblemaps.com/scim/v2 - SCIM Bearer Token: ScribbleMaps SCIM токенін қойыңыз
-
SCIM Base URL:
- Provisioning қойындысына өтіп, провизияны қосыңыз
- Пайдаланушыларды тағайындау үшін Users қойындысына өтіңіз
JumpCloud
- JumpCloud Admin ішінде SSO Applications бөліміне өтіңіз
- Жаңа қолданба қосу үшін + түймесін басыңыз
- Custom SCIM таңдаңыз
- Баптаңыз:
-
Base URL:
https://api.scribblemaps.com/scim/v2 - Token Key: ScribbleMaps SCIM токенін қойыңыз
- Authentication: Bearer Token
-
Base URL:
- Test Connection түймесін басыңыз
- Атрибуттар сәйкестігін баптаңыз
- Қолданбаға пайдаланушы топтарын тағайындаңыз
Қолдау көрсетілетін SCIM операциялары
Пайдаланушы операциялары
| Операция | Әдіс | Қолдау көрсетіледі | Сипаттама |
|---|---|---|---|
| List Users | GET /Users | Иә | Беттеу және сүзгілеумен барлық пайдаланушыларды алу |
| Get User | GET /Users/{id} | Иә | Нақты пайдаланушыны ID бойынша алу |
| Create User | POST /Users | Иә | Жаңа пайдаланушыны провизиялау |
| Replace User | PUT /Users/{id} | Иә | Пайдаланушы атрибуттарын толық жаңарту |
| Update User | PATCH /Users/{id} | Иә | Пайдаланушы атрибуттарын ішінара жаңарту |
| Delete User | DELETE /Users/{id} | Иә | Пайдаланушыны өшіру (жұмсақ жою) |
Топ операциялары
| Операция | Әдіс | Қолдау көрсетіледі | Сипаттама |
|---|---|---|---|
| List Groups | GET /Groups | Иә | Әкімші және Мүше рөлдік топтарын қайтарады |
| Get Group | GET /Groups/{id} | Иә | Топты мүшелер тізімімен алу |
| Update Group | PATCH /Groups/{id} | Иә | Рөлдік топтарға мүшелерді қосу/жою |
| Create Group | POST /Groups | Жоқ | Қолдау көрсетілмейді (рөлдер тіркелген) |
Қолдау көрсетілетін пайдаланушы атрибуттары
| SCIM атрибуты | ScribbleMaps өрісі | Міндетті |
|---|---|---|
userName |
Электрондық пошта мекенжайы | Иә |
externalId |
Сыртқы IdP идентификаторы | Жоқ |
name.givenName |
Аты | Жоқ |
name.familyName |
Тегі | Жоқ |
displayName |
Көрсетілетін аты | Жоқ |
active |
Аккаунт мәртебесі | Жоқ |
emails[].value |
Электрондық пошта мекенжайы | Жоқ |
Қолдау көрсетілетін сүзгілер
| Сүзгі | Мысал |
|---|---|
| Электрондық пошта бойынша сүзу | userName eq "[email protected]" |
| Сыртқы ID бойынша сүзу | externalId eq "12345" |
| Мәртебе бойынша сүзу | active eq true |
Пайдаланушының өмірлік циклін басқару
Пайдаланушы провизияланған кезде
- ScribbleMaps-та жаңа команда мүшесінің аккаунты жасалады
- Пайдаланушы ақпараты (аты, электрондық пошта) IdP жүйесінен толтырылады
- Әдепкі өнім бапталған және бос орындар болса, лицензия автоматты түрде тағайындалады
- Пайдаланушы SSO арқылы (егер бапталса) бірден кіре алады
Пайдаланушы жаңартылған кезде
- Пайдаланушы атрибуттары (аты, көрсетілетін аты) IdP жүйесіне сәйкес жаңартылады
- Электрондық пошта өзгерістері синхрондалады (пайдаланушы аккаунтын байланыстырмаған болса)
Пайдаланушы депровизияланған кезде
- Пайдаланушының аккаунты өшіріледі (жұмсақ жою)
- Барлық өнім лицензиялары алынып, орындар босатылады
- Барлық белсенді сеанстар бірден жарамсыз болады
- Пайдаланушы енді кіре алмайды
- Пайдаланушы деректері мен карталар сақталады (жойылмайды)
- Пайдаланушы қайта провизияланса, аккаунтты қайта белсендіруге болады
Топтар арқылы рөлдерді басқару
ScribbleMaps SCIM арқылы екі рөлдік топты ұсынады:
| Топ ID | Рөл | Рұқсаттар |
|---|---|---|
admin |
Әкімші | Команда баптауларын, пайдаланушыларды және төлемдерді басқару |
member |
Мүше | Стандартты команда мүшесінің қолжетімділігі |
Пайдаланушыны әкімші ретінде тағайындау үшін оны SCIM PATCH арқылы admin тобына қосыңыз. Иесі рөлін SCIM арқылы өзгертуге болмайды.
Ақаулықтарды жою
Жиі кездесетін мәселелер
"401 Unauthorized" немесе "Invalid token"
- Bearer токенінің дұрыстығын және кері қайтарылмағанын тексеріңіз
- Токеннің Authorization тақырыбында
Bearer YOUR_TOKENтүрінде берілгеніне көз жеткізіңіз - Токеннің мерзімі өтпегенін тексеріңіз (егер мерзімі орнатылған болса)
- Қажет болса жаңа токен жасаңыз
"409 Conflict" - Пайдаланушы бұрыннан бар
- Командаңызда осы электрондық поштасы бар пайдаланушы бұрыннан бар
- Егер бар пайдаланушы өшірілген болса, SCIM оны автоматты түрде қайта белсендіреді
- IdP жүйесінде қайталанатын электрондық пошта мекенжайларын тексеріңіз
"400 Bad Request" - Міндетті өріс жоқ
- Сұраныста
userName(электрондық пошта) бар екеніне көз жеткізіңіз - Электрондық пошта пішімінің дұрыстығын тексеріңіз
- IdP жүйесінің атрибуттар сәйкестігі баптауын тексеріңіз
Пайдаланушылар жасалды, бірақ өнім тағайындалмады
- SCIM баптауларында әдепкі өнім бапталғанын тексеріңіз
- Әдепкі өнім үшін бос орындардың бар екенін тексеріңіз
- Пайдаланушыларға өнімдерді Team Settings ішінде қолмен тағайындауға болады
Пайдаланушы өзгерістері синхрондалмайды
- Кейбір IdP жүйелері кесте бойынша синхрондайды (мысалы, Azure AD үшін әр 40 минут сайын)
- IdP жүйесінде қолмен синхрондауды мәжбүрлеп іске қосып көріңіз
- SCIM әлі қосулы екенін және токен жарамды екенін тексеріңіз
Test connection сәтсіз аяқталады
- SCIM Base URL дәл
https://api.scribblemaps.com/scim/v2болуы керек екенін тексеріңіз - Соңында қиғаш сызықтар немесе қателер жоқ екеніне көз жеткізіңіз
- Желіңіз/брандмауэріңіз api.scribblemaps.com мекенжайына шығыс HTTPS-ке рұқсат беретінін тексеріңіз
Көмек керек пе?
Егер SCIM провизиясында ақаулықтар туындаса, қолдау қызметімізге мына ақпаратты жіберіңіз:
- Команда атауыңыз
- Пайдаланып жатқан Identity Provider
- IdP провизия журналдарындағы қате хабарламалары
- SCIM конфигурациясының скриншоттары (токен жасырылған күйде)
Ұйымыңызда SCIM провизиясын баптауға көмектесуге дайынбыз.
Соңғы жаңартылған уақыты