> For the complete documentation index, see [llms.txt](https://knowledgebase.autorabit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/ci-cd-integration/pipeline-access-tokens.md).

# Pipeline Access Tokens

A pipeline signs in to IZ Suite with an access token. The token acts as the person who created it, with only the roles chosen for it. For pipelines, give it the **Pipeline scanner** role and nothing else.

{% hint style="info" %}
Requires the **Code Analysis** licence.
{% endhint %}

## The Pipeline Scanner Role

**Pipeline scanner** is a role made for pipeline tokens. It lets the scanner read what it needs to run and record results, and nothing more:

* Read the quality profiles, quality gates, metric profiles, quality rules and global settings the scanner uses.
* Create and update Code Analysis applications for each technology that is licensed and installed, in the default organization.

To create it, open **Administration** → **Setup** → **Create roles for pipelines and AI assistants**, tick **Create a Pipeline scanner role**, keep **Also give me these roles so my tokens can carry them** ticked, and click **Create roles**. Nothing already in a role is removed; if the role exists, missing permissions are added. See [Setup](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/administration/setup.md).

{% hint style="warning" %}
A token can carry only roles its owner holds. If **Pipeline scanner** is not offered when you create the token, ask an administrator to give you the role in [Roles](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/administration/organizations/roles.md).
{% endhint %}

{% hint style="danger" %}
The scanner reads global settings, and that permission also shows the secrets saved in them. Treat a pipeline token like a password: keep it in a masked secret and never in a file you commit.
{% endhint %}

### Scan Into Other Organizations

The role's scan rights cover the default organization. When your pipeline passes `-organization` to file results under another organization, the token's role must also cover that organization: open the role's **Permission matrix** in [Roles](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/administration/organizations/roles.md), click **Add permissions** and pick the organizations. Otherwise the scan stops with an error saying the organization was not found or the token lacks permission to configure the application there.

## Create a Token for a Pipeline

You can create the token from Setup or from **Access tokens**. Both open the same form.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FBwHyipIx7dKqsKweLVCu%2Fv2-cicd-token-create.png?alt=media&amp;token=d1d658e2-4034-4655-8863-df0dc3216fdd" alt="Create access token form with the token name, Act as me switched off, the Roles field and the expiry date"><figcaption></figcaption></figure>

1. Open **Administration** → **Setup** → **Scan in your CI/CD pipeline** and click **Create access token** (or click **Create access token** in [Access Tokens](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/administration/organizations/access-tokens.md)).
2. Enter a **Token name**, for example "CI pipeline". Use one token per pipeline or repository so you can disable one without stopping the others.
3. Switch off **Act as me**, then under **Roles** choose **Pipeline scanner**. With **Act as me** on, the token carries every role you hold.
4. Set **Expires on**. Prefer an expiry date and rotate the token before it.
5. Click **Create token**.
6. Copy the value under **Copy this token now**. It is shown only once.

## Store the Token as a Pipeline Secret

Store the value as a masked secret named `IZ_ACCESS_TOKEN`. The steps that Setup generates read it from there and never contain the token.

| CI/CD platform      | Where to store it                                                                                              |
| ------------------- | -------------------------------------------------------------------------------------------------------------- |
| Bitbucket Pipelines | A secured repository or workspace variable `IZ_ACCESS_TOKEN`.                                                  |
| GitHub Actions      | A repository or organization secret `IZ_ACCESS_TOKEN`, read as `${{ secrets.IZ_ACCESS_TOKEN }}`.               |
| GitLab CI           | A masked CI/CD variable `IZ_ACCESS_TOKEN`.                                                                     |
| Jenkins             | A **Secret text** credential with the ID `iz-access-token`, bound to `IZ_ACCESS_TOKEN` with `withCredentials`. |
| Maven               | Any of the above; the command passes it as `-DauthToken="$IZ_ACCESS_TOKEN"`.                                   |

{% hint style="danger" %}
Never paste the token into a pipeline file, a `pom.xml` or a settings file. Anyone who can read the repository could then scan as you.
{% endhint %}

## Check That the Token Works

The **Scan in your CI/CD pipeline** step in Setup checks every 15 seconds and turns **Done** once your token has been used and a pipeline scan has arrived since you created your oldest active token. Run the pipeline once and watch the step.

## Rotate, Disable or Remove a Token

* **Rotate**: create a new token with the same role, replace the secret value in your CI/CD platform, run the pipeline once, then disable the old token.
* **Disable**: click **Disable token** on the token's row in [Access Tokens](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/administration/organizations/access-tokens.md) or **Disable credential** in [Security Credentials](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/administration/my-account/security-credentials.md). The pipeline loses access on its next request. You can enable it again later.
* **Expired tokens** stop working on their expiry date. The **Expiring in 30 days** tile in **Access tokens** lists the ones to rotate soon.

A token's value cannot be shown again. If it is lost, create a new token.

## Next Steps

* [Command-Line Scanner](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/ci-cd-integration/command-line-scanner.md): use the token with the scanner.
* [Pipeline Examples](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/ci-cd-integration/pipeline-examples.md): add the scan step to your pipeline.
* [Access Tokens](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/administration/organizations/access-tokens.md): review every token in the workspace.
* [CI/CD Integration](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/ci-cd-integration.md): how a pipeline scan works.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/ci-cd-integration/pipeline-access-tokens.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
