When Oomnitza syncs with JetBrains returns all customer licenses.
For more information, see Get customer licenses in JetBrains Account API.
Navigation
Adding JetBrains global variables
Before you start
To sync JetBrains with Oomnitza, you must retrieve:
- Your JetBrains API key
- Your JetBrains company code or unique Organization ID.
To get your JetBrains API key, complete the following steps:
- Go to your JetBrains Account.
- In the menu on the left, click your organization's or team's name and then click Administration.
- Click Generate Token. Your administrator may need to enable the API in advance so that you can create a token.
To find your company code, go to your JetBrains Account and look for the number next to your organization's name.
To easily find the records that are uploaded to Oomnitza, it's best practice to create a dedicated user account for each integration. This will make it easier for you to retrieve the records that are uploaded to Oomnitza from the vendor application.
Adding global variables
Save time when you create integrations and run workflows by adding connection information as global variables.
- Click Configuration > General > Global Settings.
- Click Add new variable.
- Add the key value, which is the name of the variable.
- Enter the value.
- Save your changes.
The name of the variable is JetBrains.Company Code and the value is your company code.
Adding credentials
- In Oomnitza, click Configuration > Security > Credentials.
- Click Add new credential (+).
- Search for the integration, and then click the forward button > to select the integration.
- Enter your client credentials and any other additional information.
- Click Authenticate. You are prompted to log in to authorize your request.
- Click CREATE.
Note
If the integration is not listed, click Advanced Mode, and add your credentials.
- Add the information details.
- Click the AUTHORIZATION tab.
- Ensure that API Key is selected as the Authorization type.
- Ensure that the Token Name is X-Api-Key
- Enter the API Key.
- Ensure that Add to Header is selected.
-
Click CREATE.
Creating the integration
- In Oomnitza, click Configuration > Integrations > Overview.
- Click Block view
.
- On the Integrations page, scroll down to the Extended section for user integrations.
- Click NEW INTEGRATION.
- In the sidebar, search for the integration.
- Click ADD.
Integration details overview
More information is provided about the following fields to help you complete the integration:
- User only. Add user records.
- User plus SaaS user. User records and SaaS user records are retrieved. User records are displayed on the People page and SaaS user records can be accessed when you open the SaaS application record on the SaaS page and click the Users tab. In addition to retrieving information about the SaaS application such as usernames, you also retrieve key information such as the user's SaaS role and last activity which will enable you to reduce costs by monitoring SaaS usage and removing users who aren't using the SaaS application. To maintain data hygiene, you can enable the deactivate feature.
- Software SaaS Selection. Link the vendor application to the Oomnitza Software Catalog which is a repository of supported vendor applications and services. If an entry for the vendor application is not shown in the list, it means that the vendor application has not been added to the SaaS page in Oomnitza and linked to the catalog. See SaaS details overview. You can ignore this field because the vendor application is automatically linked to the catalog when the integration is saved.
Important
Now that user information can be retrieved and users deactivated when the integration is run, you can deactivate or remove the workflows that were added to retrieve SaaS user information and deactivate SaaS users. (The block that is used to complete these actions in workflows is the SaaS User Role Retrieval block.)
When you enable the Deactivate feature, the following actions are completed when the integration runs:
- If a user record is missing from the data source - the vendor application - or if the record is marked as inactive in the data source, the user record is deactivated in Oomnitza.
- If a user record was deactivated and is now available in the data source, for example, the user logs into the SaaS application, the user record becomes active in Oomnitza.
Installation types
- Cloud. Store credentials in the Oomnitza cloud.
- Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAuth authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication.
Integration preferences
- Create & Update. Add and update records.
- Create only. Add records.
- Update only. Update records.
Editing the integration details
When you edit the Integration details section, you can select the name or names of integration contacts. Integration contacts will receive an in-app notification and an email, when the integration fails, when the integration fails to complete within 24 hours, or when the scheduled integration fails to run.
- Click Edit
.
- Make your changes.
Editing the credential details
If you selected Cloud as the installation type, choose one of the following options:
- Select the credentials that were created for the integration.
- Edit the credentials that were created for the integration.
- Create new credentials
Scheduling the integration
By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.
- Click Edit
.
- Make and save your changes.
Mapping fields to Oomnitza
To map the fields to Oomnitza, click Edit .
Select Edit integration to add rules for syncing data.
Filtering integration results.
You can add new fields to your integration by selecting Add new field on the mapping page.
Creating custom API fields.
Mappings
To map the fields to Oomnitza, click the pencil.
Creating custom mappings
Map the JetBrains fields to Oomnitza fields and create custom mappings to get the user information that you need.
Complete these actions:
- Click Smart Mapping to automatically detect appropriate mapping fields. Values from the integration can also be dragged to the appropriate field on the Oomnitza side, or selected from the integration field dropdown.
-
Create a custom mapping for the JetBrains License ID. To do this, complete the following steps:
- Select the down arrow on the License ID field that you want to map.
- Select Add new Oomnitza users field.
- Change the name of the field to JetBrains License Id.
- Select the Unique checkbox.
- Click CREATE.
- Ensure that the Email is mapped to the
- Username field on the Oomnitza side (required for integration).
- Email field on the Oomnitza side (required for integration).
- Select the Role field on the Oomnitza mapping side.
- Choose a suitable role from the list (a defined role is necessary for the integration)
- Assign a sync key to a unique field, such as the Email.
- Click UPDATE.
Tracking information for user loads
When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the following fields to Oomnitza:
- Connect: Credentials
- Connect: JetBrains Company Code
Standard JetBrains to Oomnitza mappings
The following JetBrains fields can be mapped to Oomnitza:
Assignee Name
Assignee Type
Connector Sync Time
Email
Is Available To Assign
Is Subscription Is Automatically Renewed
Is Subscription Is Outdated
Is Suspended
Is Transferable Between Teams
Is Trial
Last Seen Is Offline Code Generated
Last Seen Last Assignment Date
Last Seen Last Seen Date
License Id
Product Code
Product Name
Subscription Pack Ref
Subscription Valid Until Date
Team Id
Team Name
Did you know?
You can define rules for your integration by selecting Edit integration at the top of the screen. For example, you may only want to run the integration if a certain contact or region exists. See Filtering integration results.
You can add new fields to your integration by selecting the + (Add) option. All you need to do is specify the field name and then enter the JSON path, for example {{response.email}}. See Creating custom API fields.
Launching the integration
Your integration is in Draft mode until all the required mandatory fields are added. Once you have added all of the required fields, we recommend that you complete the following steps
- Select Launch to activate your integration
- Change your Integration preferences to Update only so that no records are imported and do a Test Run.
- Click Sync Sessions and review the status of the integration. If you encounter any errors, see troubleshooting integrations.
- When the test run has been completed, change your Integration preferences and click Run Now.
Getting your results
To view the information that is collected about your assets, click Assets. To view the information about software, click the Software tab. To view the information that is collected about your users, click People.
Creating workflows
Creating user workflows with the API block
To create a user workflow, you must complete these steps:
- Click Configuration > Workflows > People.
- Click Add (+) and enter the name and description of the workflow.
- Click Add new. A Begin and End block are automatically added to the Sandbox.
- Edit the Begin Block and add rules to trigger the workflow. For example, if you set the Actions to Schedule and add a rule so that the Email Equals <EmployeeEmail> you can trigger a workflow to fetch a user matching a certain name on a specific date. Refer to Using the Begin block.
- Drag and drop the API block onto the Sandbox.
- Click Edit on the API block and enter JetBrains in the search field.
- Select a preset from the list below. To choose a preset, click the forward arrow (>).
- Select the credentials that you created in Adding the credentials.
- Supply the company code or Organization ID that you retrieved in JetBrains.
- Select Advanced Mode.
-
Select the Response tab. You can map the entire response by placing
{{response}}in the Response field and mapping it to a custom Oomnitza field. See Mapping positive and negative responses - Connect the Blocks.
- Save, validate, and activate your workflow.
JetBrains Get all Licenses for a User by Email
The Get all Licenses for a User by Email retrieves all user licenses by email.You'll need to supply the Map Licenses to Field name so that you can map the License ID's returned in the response to an Oomnitza field. If you are unsure of what your Oomnitza field name is, navigate to Configuration > Data Model > Field Configuration and select the field from the list. The correct field name is located in the External ID.
An email is required to fetch the user licenses and is referenced in the in the Advanced Mode > Params tab.
For further information on the API used in the request, see JetBrains Docs: Get customer/licenses
JetBrains Account Revoke License
The Account Revoke License revokes a user's license.
An email is required to fetch the user licenses and is referenced in the Advanced Mode > Params tab.
For further information on the API used in the request, see JetBrains Docs: Post customer/licenses/revoke
JetBrains Account Assign License to User
The Account Assign License to User preset assigns a license to a user. You'll need to supply the License ID, Team ID, and Product Code to run the workflow. Create the user integration first so that you can retrieve these values.
For further information on the API used in the request, see JetBrains Docs: Post customer/licenses/assign
Reference articles for creating workflows
Creating SaaS user workflows
You can create a SaaS User workflow in Oomnitza using the JetBrains Subscription License SaaS User Role preset. This workflow will fetch user licenses, including the product name and last seen date, and if the license retrieved has an outdated subscription, it will categorize it as 'Expired Subscription.
Important
The integration has been updated to automatically retrieve SaaS user role information when Oomnitza syncs with JetBrains. You also have the option to deactivate users.
Prerequisites
Before you create a SaaS user workflow, you should have already run your extended user integration and selected User plus SaaS User to populate the software entry in the Software > SaaS menu.
Creating the workflow
To create a SaaS User workflow, complete the following steps:
- Click Configuration > Workflows > SaaS Users from the menu.
- Click Add (+). The Begin and End blocks are automatically added to the sandbox.
- Enter the name and a description of the workflow.
- Edit the Begin block by adding the rules that will trigger the workflow. For further information see SaaS User Roles.
- Click the Blocks tab, and drag and drop the SaaS User Role retrieval block onto the canvas.
- Click the Edit icon.
- Enter JetBrains in the search field and choose the Jetbrains Licenses SaaS User Role preset.
- Click the right arrow >.
- Select your API key credentials.
- Supply the company code or Organization ID that you retrieved in JetBrains.
- Select the Deactivate User checkbox to deactivate the SaaS user in SaaS > Jetbrains > Users if they are not found in your JetBrains instance.
- Click SAVE.
- Connect the blocks.
- Save, validate, and activate your workflow.
To view active JetBrains users in the SaaS Users UI, complete the following steps:
- Click Software from the menu.
- Select the SaaS tab, and select your software entry for Jetbrains.
- Click Users in the side pane.
- The Last activity and Role column will be populated with the user details to confirm that this user has been found in your JetBrains SaaS.
Reference articles for creating workflows
Unleash the power of Oomnitza
To get valuable actionable insights that help you manage your users, learn how to:
- Configure dashboards for your users and software
- Configure custom reports about your users and software
- Create workflows to automate tasks
See Getting started for more information.
Comments
0 comments
Please sign in to leave a comment.