IDE Services Cloud Help

JetBrains Account Auth Module

The JetBrains Account authentication module lets users, who have registered for a JetBrains product or service, log in to IDE Services with their JetBrains Account credentials.

JetBrains account authentication module.

Enable JetBrains Account Authentication

When you first access Hub, the JetBrains Account authentication module is already created and enabled. If you remove this authentication module, you can create it again later.

To create the JetBrains Account auth module:

  1. In the Administration menu, select Auth Modules.

  2. Click New Module.

    • The Select an identity provider dialog opens.

      Select an identity provider
  3. Select the JetBrains Account auth module.

    • The Auth Modules page displays the settings for the JetBrains Account authentication module.

  4. Specify the allowed domains and emails.

  5. Click the Enable button in the header.

    • The JetBrains Account auth module is added to Hub.

    • The auth module is enabled and ready for use.

After the module is created, you can configure the optional settings, for example, enable registration or add users to groups when they register a new account. For more information, refer to Additional Settings.

Settings

In the header of the settings page, you can find the general information about the authentication module.

Setting

Description

Name

Stores the name of the authentication module. Use this setting to distinguish this module from other authentication modules in the Auth Modules list.

You can change the name of the authentication module using the Rename action. For more details, refer to Actions.

Button image

Displays the image used for the button that a user clicks to log in to Hub with their JetBrains Account.

You can change the button image for the authentication module using the Rename action. For more details, refer to Actions.

You can upload a JPG, GIF, or PNG file. The image is resized to 48 x 48 pixels automatically.

Organization

Stores the link to your organization in the JetBrains Account. This field is displayed only when API access is configured.

User accounts in IDE Services

Displays the current number of users in IDE Services that logged in or were added as a result of synchronization with the JetBrains Account.

User accouts found in organization

Displays the number of user accounts that exist in your organization in the JetBrains Account.

Last sync

Displays the last time when Hub synchronized user accounts between IDE Services and the JetBrains Account.

The settings on the General tab help you configure allowed domains and emails, API access, and user synchronization between IDE Services and the JetBrains Account.

Setting

Description

Allowed domains and emails

Restricts the creation of user accounts to users with email addresses from the specified domains or specific email addresses. To specify multiple domains or email addresses, enter each value on a new line.

Hub recognizes domains with or without the @ sign, which means that you can either specify the domain as @domain.com or simply domain.com.

If a user attempts to log in with a JetBrains Account that does not match the specified domain, then:

  1. Hub will not let the user log in and will show a relevant error message.

  2. Hub will not create a new account for the user.

  3. Hub will not add this JetBrains Account to the Logins list of an existing user account, if such an account is found in the system.

Default

Sets the current authentication module as the default.

Customer code

Stores a unique number identifier of your organization in the JetBrains Account.

You can find your customer code in your JetBrains Account, next to the organization's name.

Customer API Token

Stores an API token for accessing the JetBrains Account API. By default, IDE Services generates an API token automatically during the first start of the instance.

You can replace the preconfigured token with your own by clicking Set new value. To learn how to generate your API token in the JetBrains Account, refer to this article.

Keep organization users synchronized

Determines the frequency with which user attributes and group memberships are synchronized with the JetBrains Account.

If the setting is enabled, you can choose from one of three predefined intervals:

  • Hourly

  • Every 3 hours

  • Daily at 9 AM

You can also launch the synchronization manually at any time by clicking the Sync organization users now button in the header.

If the setting is disabled, profiles and group memberships are still synchronized on a per-user basis during login.

The synchronization feature is only active when the authentication module is Enabled.

Additional Settings

The settings on the Additional settings tab let you manage Hub account creation and group membership and reduce the loss of processing resources consumed by idle connections.

Setting

Description

User creation

Enables creation of IDE Services accounts for unregistered users who log in with their JetBrains Account.

When user creation is disabled, only the following users can log in:

  • JetBrains Account users who logged in to Hub using their JetBrains Account or were added as a result of synchronization with the JetBrains Account.

  • Users already present in Hub that have a matching allowed email, which is verified.

Auto-join groups

Automatically adds new users to groups when they register themselves in IDE Services. You can select one or more groups. New users that auto-join a group inherit all the Hub permissions that are assigned to this group.

We recommend that you add users to at least one group. Otherwise, new users are only granted the permissions that are currently assigned to the All Users group. Do not use this option to add users to groups that grant unnecessary access to sensitive data.

Extension grant type

Saves the value that is used to identify the authentication module when used for extension grants. If a value is provided, Hub will process requests to exchange access tokens that are issued by the JetBrains Account for tokens that grant access to Hub.

To learn how to exchange access tokens using the Hub REST API, see Extension Grants.

Connection timeout

Sets the period of time to wait to establish a connection to the JetBrains Account. The default setting is 5000 milliseconds (5 seconds).

Read timeout

Sets the period of time to wait to read and retrieve user profile data from the JetBrains Account. The default setting is 5000 milliseconds (5 seconds).

Changes made to JetBrains Account

Links to the Audit Events page in Hub. There, you can view a list of changes that were applied to this authentication module.

Actions

The following actions are available in the header:

Action

Description

Enable

Enables the authentication module.

This option is only shown when the authentication module is currently disabled.

Disable

Disables the authentication module.

This option is only shown when the authentication module is currently enabled.

Test login

Lets you authenticate using the JetBrains Account to test if users are able to log in.

Sync organization users now

Launches the synchronization of users between the JetBrains Account organization and IDE Services.

Rename

Lets you update the existing authentication module name and change its default icon.

You can find this action in the Actions (...) menu.

Delete

Removes the authentication module from Hub. Use only when you have configured additional authentication modules that let users log into your Hub installation.

You can find this action in the Actions (...) menu.

Last modified: 24 October 2024