Настройка интеграции c TeamStorm и Test IT

В VK Dev Platform используется SSO на базе Keycloak. TeamStorm и Test IT интегрируются с Keycloak по протоколу OIDC. После настройки интеграции будет доступен новый способ входа в TeamStorm и Test IT через VK Dev Platform SSO.

В таблице 1 приведена совместимость версий VK Dev Platform с TeamStorm и Test IT для настройки интеграции.

Чтобы управлять объектами в TeamStorm и Test IT из VK Dev Platform, создайте сервисные УЗ. VK Dev Platform будет использовать их для доступа к REST API TeamStorm и Test IT.

Создайте сервисную УЗ в TeamStorm:

1. Авторизуйтесь в TeamStorm с УЗ администратора.

2. Перейдите в раздел Администрирование → Пользователи.

3. Нажмите кнопку Добавить.

4. Задайте значения параметров. В параметре Роль выберите:

   • Администратор TeamStorm и Пользователь TeamStorm — для версии 3.36.5.
   • Системный администратор и Пользователь — для версии 3.59.4.

5. Авторизуйтесь в TeamStorm с созданной сервисной УЗ.

6. Перейдите в настройки профиля в правом верхнем углу.

7. Перейдите в раздел Безопасность.

8. Сгенерируйте приватный токен.

9. Сохраните логин и приватный токен сервисной УЗ.

Создайте сервисную УЗ в Test IT:

1. Авторизуйтесь в Test IT с УЗ администратора.
2. Перейдите в раздел Администрирование → Пользователи.
3. Нажмите кнопку Добавить.
4. Задайте значения параметров.
5. Перейдите в раздел Администрирование → Системные роли.
6. В поле поиска найдите созданную сервисную УЗ.
7. Для сервисной УЗ выберите опции Администратор Test IT и Пользователь Test IT.
8. Авторизуйтесь в Test IT с созданной сервисной УЗ.
9. Перейдите в настройки профиля в правом верхнем углу.
10. Перейдите в раздел Безопасность.
11. Сгенерируйте приватный API-токен.
12. Сохраните логин и приватный API-токен сервисной УЗ.

1. Авторизуйтесь в консоли администрирования Keycloak с УЗ администратора.

2. Выберите рилм dev-platform.

3. Перейдите в раздел Clients.

4. Импортируйте новых клиентов для TeamStorm и Test IT в формате JSON или создайте их через пользовательский интерфейс Keycloak, используя примеры ниже.

   Пример клиента TeamStorm

    
   {  "clientId": "teamstorm-sso-client",  "name": "TeamStorm SSO Client",  "description": "",  "rootUrl": "https://teamstorm.<ДОМЕН>",  "baseUrl": "https://teamstorm.<ДОМЕН>",  "surrogateAuthRequired": false,  "enabled": true,  "alwaysDisplayInConsole": false,  "clientAuthenticatorType": "client-secret",  "secret": "<ПАРОЛЬ>",  "redirectUris": [    "https://teamstorm.<ДОМЕН>/admin/api/signin-oidc"  ],  "webOrigins": [    "https://teamstorm.<ДОМЕН>"  ],  "notBefore": 0,  "bearerOnly": false,  "consentRequired": false,  "standardFlowEnabled": true,  "implicitFlowEnabled": false,  "directAccessGrantsEnabled": false,  "serviceAccountsEnabled": true,  "authorizationServicesEnabled": true,  "publicClient": false,  "frontchannelLogout": true,  "protocol": "openid-connect",  "attributes": {    "realm_client": "false",    "post.logout.redirect.uris": "https://teamstorm.<ДОМЕН>/*"  },  "authenticationFlowBindingOverrides": {},  "fullScopeAllowed": true,  "nodeReRegistrationTimeout": -1,  "defaultClientScopes": [    "service_account",    "web-origins",    "acr",    "profile",    "roles",    "email"  ],  "optionalClientScopes": [],  "access": {    "view": true,    "configure": true,    "manage": true  }}

   Пример клиента Test IT

    
   {  "clientId": "testit-sso-client",  "name": "TestIT SSO Client",  "description": "",  "rootUrl": "https://testit.<ДОМЕН>",  "baseUrl": "https://testit.<ДОМЕН>",  "surrogateAuthRequired": false,  "enabled": true,  "alwaysDisplayInConsole": false,  "clientAuthenticatorType": "client-secret",  "secret": "<ПАРОЛЬ>",  "redirectUris": [    "https://testit.<ДОМЕН>/api/auth/signin-oidc"  ],  "webOrigins": [    "https://testit.<ДОМЕН>"  ],  "notBefore": 0,  "bearerOnly": false,  "consentRequired": false,  "standardFlowEnabled": true,  "implicitFlowEnabled": false,  "directAccessGrantsEnabled": false,  "serviceAccountsEnabled": true,  "authorizationServicesEnabled": true,  "publicClient": false,  "frontchannelLogout": true,  "protocol": "openid-connect",  "attributes": {    "realm_client": "false",    "post.logout.redirect.uris": "https://testit.<ДОМЕН>/*"  },  "authenticationFlowBindingOverrides": {},  "fullScopeAllowed": true,  "nodeReRegistrationTimeout": -1,  "defaultClientScopes": [    "service_account",    "web-origins",    "acr",    "profile",    "roles",    "email"  ],  "optionalClientScopes": [],  "access": {    "view": true,    "configure": true,    "manage": true  }}

   Здесь:

   • <ДОМЕН> — доменное имя сервера, на котором размещен TeamStorm или Test IT.
   • <ПАРОЛЬ> — пароль для добавляемого клиента.

5. Авторизуйтесь в TeamStorm с УЗ администратора.

6. Перейдите в раздел Администрирование → Интеграции → OpenID.

7. Нажмите кнопку Добавить.

8. Задайте параметры:

   • Название интеграции. Пример: VK Dev Platform SSO.
   • Authority — адрес провайдера https://keycloak.<ДОМЕН_VK_DEV_PLATFORM>.
   • Endpoint — эндпоинт для получения конфигурации OpenID https://keycloak.<ДОМЕН_VK_DEV_PLATFORM>/realms/dev-platform/.well-known/openid-configuration.
   • Client ID — идентификатор клиента, указанный при добавлении. В примере это teamstorm-sso-client.
   • Client Secret — пароль, указанный при добавлении клиента.

9. Нажмите кнопку Добавить.

10. Авторизуйтесь в Test IT с УЗ администратора.

11. Перейдите в раздел Администрирование → Подключения → OpenID Connect.

12. Нажмите кнопку Создать.

13. Задайте параметры:

    • Название подключения. Пример: VK Dev Platform SSO.
    • Authority — адрес провайдера https://keycloak.<ДОМЕН_VK_DEV_PLATFORM>.
    • Endpoint — эндпоинт для получения конфигурации OpenID https://keycloak.<ДОМЕН_VK_DEV_PLATFORM>/realms/dev-platform/.well-known/openid-configuration.
    • Client_id — идентификатор клиента, указанный при добавлении. В примере это testit-sso-client.
    • Client_secret — пароль, указанный при добавлении клиента.

14. Нажмите кнопку Сохранить.