Access rules
To restrict and fine-tune access to licenses within your organization, configure access rules and priorities.
In this section, you'll learn how licenses are distributed before any rules are created and how rules change user access.
By default, before any rules are created, all users authorized by JetBrains Hub have access to all licenses.
Rules help you restrict and fine-tune user access. Here's how it works:
- If you create a rule for a specific user or group:
These users and groups only have access to the licenses specified in the rule.
- If there are no rules for a specific user or group:
These users and groups have access to any available licenses. To restrict their access, you need to create a rule.
For example, let's say you have a single rule that grants User A
access to PyCharm
licenses. Here's how this rule is applied:
If
User A
requests aPyCharm
license, they successfully obtain one.If
User A
requests aCLion
license, their request is denied because, according to your rule set, they are only allowed to usePyCharm
.If
User B
requests aCLion
orPyCharm
license, they successfully obtain one because there aren't any rules that restrict their access.
You can enforce a stricter license distribution policy so that access is only granted to the users and groups that are explicitly mentioned in your access rules.
If you do this, the semantics of your rules will change from restricting access to granting it.
- If you create a rule for a specific user or group:
These users and groups only have access to the licenses specified in the rule. (No change here.)
- If there are no rules for a specific user or group:
These users and groups don't have access to any licenses. To grant them access, you need to create a rule.
Going back to the example with a single rule that grants User A
access to PyCharm
, here's what will change:
If
User A
requests aPyCharm
license, they'll still successfully obtain one.If
User A
requests aCLion
license, their request will still be denied.But if
User B
requests aCLion
orPyCharm
license, their request will now also be denied because there are no rules that grant this user access to licenses.
warning
Before restricting global access, make sure to create rules that confugure user access licenses. Otherwise, none of your users will be able to obtain licenses.
In the menu on the left, select Rules.
At the top of the page, clear the Allow users that are not mentioned in the rules to get licenses checkbox.
Confirm your action in the dialog that pops up.
This section walks you through the process of creating an access rule. Before you begin, make sure that you have configured user authentication in JetBrains Hub.
In the menu on the left, select Rules.
In the top-right corner, click Add rule.
In the dialog that pops up, enter the name of your rule.
In the same window, under Username or group from JetBrains Hub, enter the name of the user or group to which this rule will apply.
Simply start typing to see all available user and group names on the suggestion list. If the name you're looking for is not on the list, check the existing users and groups in JetBrains Hub to make sure that you're typing the name correctly.
GifClick Next. This will take you to the Specify products tab of the rule settings.
From the dropdown list, select the products you want these users to have access to. You can select multiple products.
The list will only display products for which you have at least one license in your License Vault.
Click Next. This will take you to the Test rule tab of the rule settings.
In this step, you can check the effective permissions that will be granted to users based on your current set of rules, including the one that you're creating.
To do so, select the user or group and a product from their respective dropdown lists and click Check effective permissions.
On the Result tab, you'll see whether the user or group you selected is allowed to use this product.
On the Related Rules tab, you'll see which rules affect their current permissions.
If your rule has the effect you're aiming for, click Finish & Save Rule to save it.
note
Creating a rule that restricts a user's access to licenses does not automatically revoke any licenses this user has already obtained, even if they are no longer permitted to use these licenses.
You will need to manually revoke any such licenses from the user after creating the rule.
Sometimes, more than one rule can apply to the same user. This can happen if:
You intentionally create multiple rules that include the same user by username.
The user belongs to multiple groups, and separate rules exist for each group.
The user is included by username in one of the rules, but other rules apply to them based on their group membership.
In such case, the user is allowed to obtain licenses for any of the products specified in the rules that apply to them.
For example, let's say you created a rule that allows User A
to use PyCharm
and then a second one that allows them to use CLion
. In this case, User A
will be able to obtain licenses both for PyCharm
and CLion
.
You can always check the effective permissions granted to any user or group based on your current set of rules.
In the menu on the left, select Rules.
In the top-right corner, click Test rules.
Select a user or group and a product from their respective dropdown lists and click Check effective permissions.
On the Result tab, you'll see whether the user or group you selected is allowed to use this product.
On the Related Rules tab, you'll see which rules affect their current permissions.
As a License Vault administrator, you can edit, disable, and remove rules.
In the menu on the left, select Rules.
In the rule list, locate the rule you want to disable.
Click on the toggle next to that rule, situated in the On/Off column.
The rule will remain on the list, but it will no longer affect the users' effective permissions. You can always re-enable it by clicking on the toggle again.
In the menu on the left, select Rules.
In the rule list, locate the rule you want to remove.
Click the menu icon with three dots next to the rule.
In the menu, select Remove.
warning
Removing a rule cannot be undone. If you plan on using this rule again in the future, consider disabling it instead of removing it.
In the menu on the left, select Rules.
In the rule list, locate the rule you want to edit.
Click the menu icon with three dots next to the rule.
In the menu, select Edit.
To edit the rule, follow the same steps you followed when adding it.
note
The instructions in this section are applicable if you're using a standalone instance of License Vault. If you're using License Vault as part of IDE Services Cloud, refer to the IDE Services documentation.
Add users or groups to the priority list to ensure they can get licenses even if your team reaches the maximum license capacity.
As long as License Vault has enough licenses for everyone, prioritized users are treated the same as everyone else.
Priority settings start working when all of the licenses are taken. In this case, License Vault denies requests from non-prioritized users. However, if a prioritized user requests a license, License Vault revokes one from a non-prioritized user and transfers it to the prioritized user.
License Vault picks a non-prioritized user at random to revoke their license. The selection mechanism varies slightly depending on your usage plan:
With Organization True-Up, License Vault first checks for licenses that are allocated to users but not currently in use, and revokes the first one it finds. If all of the licenses are in use, License Vault revokes a license from a randomly selected non-prioritized user.
With Enterprise Floating, License Vault always revokes a license from a randomly selected non-prioritized user.
A prioritized user's request can only be denied in one of the following cases:
License Vault has no licenses that match the user's request. For example, if the License Vault administrator only added
PyCharm
licenses, and the user requests a license forCLion
.All of the licenses that match the user's request are already taken by other prioritized users.
Rules prohibit that this user obtains the requested licence. Priority does not override rule restrictions.
In the menu on the left, select Rules.
At the top of the page, select the Priorities tab.
In the top-right corner, click Edit Priorities.
Edit the list of prioritized users and groups.
To add a new prioritized user or group, enter their name into the corresponding field.
Simply start typing to see all available user and group names on the suggestion list. If the name you're looking for is not on the list, check the existing users and groups in JetBrains Hub to make sure that you're typing the name correctly.
GifTo remove a prioritized user or group, click on the x button next to their name.
Click Save Priorities to save your changes.
Thanks for your feedback!