This article is for organizations with free сlassroom licenses. If your organization uses commercial licenses, you'll manage everything in the new, enhanced JetBrains Central Console. You can find detailed instructions in the JetBrains Central Console documentation.

With the JetBrains Account API, you can manage your organization’s licenses and user accounts automatically.

You can use the API to:

• Get license details
• Assign or revoke licenses
• Transfer licenses between teams
• Create or delete user accounts

JetBrains Account API reference

For the full list of API methods, see the JetBrains Account API reference.

The account management features are only available to organizations with a verified domain.

API access levels

Your role in the organization profile determines what you can do in the JetBrains Account UI, what info you can access through the API, and whether you’re allowed to change it. 

Enable or disable the API

To enable the API:

1. Log in to your JetBrains Account.
2. In the menu on the left, click on your organization's name.
   
3. In the menu that appears, select Administration.
   
4. In the JetBrains Account API section, click Enable API. 
   
    

This gives API access to all admins and viewers They'll be able to generate personal API tokens and, depending on their role, access the organization or team profile through the API.

Disable the API

To disable the API, follow steps 1–3 in the instructions above and then click Disable API. This will disable the API for everyone in the organization.

Disabling the API blocks access to the organization via the API, but it doesn't invalidate any tokens that were already generated. If you enable the API again later, those tokens will still work. See Token lifetime for details.

Manage API access tokens

If your role in the organization profile gives you API access, you can generate a personal access token and regenerate or invalidate it whenever needed. Organization and team admins can also manage tokens generated by others in their organization or team. 

Manage your personal API token

To use the API, you’ll need a personal access token. You can generate, regenerate, or invalidate it anytime. Your token is tied to your account, so any API requests made with it will be linked to you. Other members of your organization with API access can generate their own tokens too. 

Generate a personal token

1. Make sure the JetBrains Account API is enabled in your organization.
2. Log in to your JetBrains Account.
3. In the menu on the left, select one of the following, depending on your role:
   • If you're an org admin or viewer, click on your organization's name:
     
   • If you're a team admin, click on your team's name:
     
4. In the JetBrains Account API section of the Administration page, click Generate access token.
   

5. When the dialog pops up, you’ll see your token. For security reasons, we only show it once – so make sure to save it somewhere safe before closing the dialog. 
   

   Don’t share your token with anyone. If it's compromised, invalidate it or generate a new one immediately.

Generate a new personal token

You might need to generate a new personal token if:

• You lost access to your current one.
• Your token was compromised.

To generate a new token:

1. Follow steps 1–3 in the instructions to generate a personal token.
2. In the JetBrains Account API section of the Administration page, click Generate new token.
   
3. When a confirmation dialog pops up, click Generate new token again.
4. In the next pop-up dialog, you’ll see your new token. For security reasons, we only show it once – so make sure to save it somewhere safe before closing the dialog.

When you generate a new token token, the old one is immediately invalidated. Make sure to update your token in any applications using the JetBrains Account API.

Invalidate a personal access token

If you no longer need access to the API, follow these steps to invaidate your token:

1. Follow steps 1–3 in the instructions to generate your token.
2. In the API section of the administration page, click Invalidate token.
   
3. When a confirmation dialog pops up, click Invalidate token again.

Manage API tokens generated by others

As an org or team admin, you can view and revoke API tokens generated by other members of your organization or team.

View and revoke organization-wide API tokens

1. Follow steps 1–3 in the instructions above to open the org administration page.
2. On the administration page, scroll down to Users with access to company licenses.
3. In the API token column, you'll see everyone in your organization who's generated a token.
4. To revoke a token, find the user in the table and click Revoke.
   

View and revoke team-specific API tokens

1. Follow steps 1–3 in the instructions to generate your token to open the team administration page.
2. On the administration page, scroll down to the Team Administration section.
3. In the API token column, you'll see everyone in your team who's generated a token.
4. To revoke a token, find the user in the table and click Revoke.
   

Token lifetime

Once issued, JetBrains Account API tokens have an indefinite lifetime. 

Each user gets one token, even if they have multiple roles. Unless they regenerate or remove it, the token stays active as long as they keep at least one role. If they lose all roles, the token gets revoked automatically.

If you disable the API and enable it again later, any previously generated tokens will still be valid unless you remove or regenerate them.

If your personal token gets compromised, regenerate or remove it immediately. If someone else's token is compromised, revoke it.

Use API methods

See the JetBrains Account API reference for the full list of available methods. Note that the account management features are only available to organizations with a verified domain.

To use the API methods, you'll need two parameters:

1. Your customer ID for X-Customer-Code

Your JetBrains customer ID is a unique identifier linked to your organization's orders and licenses. You can find it in your JetBrains Account.

Use this value for the X-Customer-Code parameter in your request.

2. Your access token for X-Api-Key

Follow the steps above to generate your personal token. Use it for the X-Api-Key parameter.