> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/sonarqube-cloud-integration-setup.md).

# SonarQube Cloud Integration Setup

### Getting Started

Use this guide to connect SonarQube Cloud to your BalkanID tenant. You will need a token from SonarQube Cloud and access to the Integrations section in BalkanID.

#### Requirements:

Before you begin, collect the following values from SonarQube Cloud:

* **API Key**
* **Region (sonarcloud.io or sonarqube.us)**
* **Organization key (optional)**

{% hint style="info" %}
A SonarQube Cloud token carries the permissions of the user who created it. Generate the token from an account that is an administrator of the organization you want to extract, otherwise SonarQube Cloud returns only a limited view of its members.
{% endhint %}

### Configure SonarQube Cloud within your BalkanID tenant

1. To find the **API Key**, sign in to SonarQube Cloud as an organization administrator.
2. Open the account menu and go to **My Account** > **Access Tokens** > **Personal Tokens**.
3. Enter a name for the token, choose an expiration, and click **Generate**. Copy the value straight away — SonarQube Cloud displays it only once.
4. Note the **Region** your organization runs on: `sonarcloud.io` for the EU instance, or `sonarqube.us` for the US instance. A token is only valid on the region it was created in.
5. If you want to limit the sync to one organization, copy its **Organization key** from your organization's settings. Providing it scopes the sync to that organization; leaving it empty extracts every organization the token can access.
6. In BalkanID, go to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FKgAXHtaMNR6vq6KMPOJM%2Fsonarqube-cloud-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top right"><figcaption><p>Integrations page</p></figcaption></figure></div>

7. Search for SonarQube Cloud, select it, and click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbpowSp7HG3KfywLtarA%2Fsonarqube-cloud-connect-application.png?alt=media" alt="The Connect a new application step with SonarQube Cloud found by search and shown as a selectable card"><figcaption><p>Connect a new application</p></figcaption></figure></div>

8. Under **Select Extraction Type**, choose **Direct Configuration**, paste your values into the corresponding fields, then click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2Fz7pBkn46N8kz9DJ9KG7M%2Fsonarqube-cloud-direct-configuration.png?alt=media" alt="The Direct Configuration fields for SonarQube Cloud: API Key, Region and Organization key"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

9. Click Next to move onto *Optional Configuration.*
10. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="The Optional Configuration step showing Reviewer Settings on the left and Select Fulfillment options on the right"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

11. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

### What BalkanID extracts

| Data                 | Description                                                                                                                    |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| **Users**            | The members of each organization the token can access, with their email address and the identity provider they sign in through |
| **Groups**           | The groups defined in each organization                                                                                        |
| **Group membership** | Which users belong to which group, which is how SonarQube Cloud expresses access                                               |

### Integration Scopes

| Read Only Scopes                                                                                                                                                                                                                                                      | Lifecycle Management Scopes |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| **Organization administrator** — SonarQube Cloud tokens do not carry individual scopes. The token inherits the permissions of the account that created it, and administrator access to the organization is required to read its members, groups and group membership. | N/A                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/sonarqube-cloud-integration-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
