> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect NetBird with Access Token – StackOne Hub

> Link a NetBird account in the StackOne Hub using Access Token. End-user guide to authorize the integration and start using NetBird actions.

> [!WARNING]
>
> Creating a service user needs the Owner or Admin role. Give the service user the Auditor role, the smallest role that reads every configuration. NetBird says: "An Auditor can read every configuration in the account but can't modify anything."

## Find your server URL

The **Server URL** is the address of your own NetBird management server. NetBird Cloud needs none.

<ul>
  <li>On NetBird Cloud, leave **Server URL** empty. StackOne then uses `https://api.netbird.io`.</li>
  <li>For a self-hosted NetBird, copy the scheme and host name you open the NetBird dashboard on, without any path such as `/peers`.</li>
  <li>Format: `https://{domain}`, with `:{port}` added if your address has one</li>
  <li>Example: `https://netbird.example.com`</li>
  <li>The connection always uses HTTPS, with or without the scheme or a trailing slash.</li>
  <li>A self-hosted server needs NetBird v0.44 or later.</li>
  <li>Paste the address into the **Server URL** field in StackOne Hub.</li>
</ul>

## Create a service user

A service user is a non-interactive account that owns the token, so the connection does not depend on a person's account. Create it on the account you want to review.

**1. Sign in to NetBird**

Sign in to your organization's [NetBird Cloud account](https://app.netbird.io) as an Owner or Admin. For a self-hosted NetBird, sign in to your NetBird instance at the address you found above.

<ul>
  <li>Navigate to **Team** -> **Service Users**.</li>
</ul>

**2. Create the service user**

Click **Create Service User** and enter a name such as `StackOne Integration`.

<ul>
  <li>The role list starts on **User**. Change it to **Auditor**. It reads every configuration, including users, groups and activity, and cannot change anything.</li>
  <li>Auditor lists only this service user's own access tokens. NetBird shows the access tokens of other service users only to an **Admin** or **Owner**, and a person's tokens only to that person.</li>
  <li>Choose **Admin** only if you need the access tokens of other service users. **Admin** also manages users, peers, networks and account settings.</li>
  <li>Click **Create Service User**.</li>
</ul>

## Create the access token

Any service user can read the whole account. Use one with the Auditor role, so the token cannot change anything.

**1. Open the service user**

In **Service Users**, click the service user you created.

**2. Create the token**

Click **Create Access Token**.

<ul>
  <li>Name: `StackOne Integration`</li>
  <li>In **Expires in**, enter how many days the token stays valid, from 1 to 365. The field starts at 30. NetBird has no token that never expires.</li>
  <li>When the token expires, the connection stops working until you paste a new token into StackOne Hub. You cannot change a token after you create it.</li>
  <li>Click **Create Token**.</li>
</ul>

**3. Copy the token**

Click **Copy to clipboard** and store the token securely for use later.

<ul>
  <li>The token is only shown once and cannot be retrieved later. NetBird says "This token will not be shown again, so be sure to copy it and store in a secure location." NetBird stores only a hash of the token.</li>
  <li>Paste it into the **Access Token** field in StackOne Hub.</li>
</ul>

## Use a person's token instead

A personal access token also works if the person's role can read users, such as **Auditor**, **Admin** or **Owner**. Create it the same way on your own user under **Team** -> **Users**. A **Billing Admin** token reads only that person, so the connection is refused. A token of a person in a managed service provider account reads that person's default account.

## Limits and revoking access

On NetBird Cloud, NetBird limits API use to 120 requests per minute with a burst of 1200. To stop StackOne reading your account, open the service user under **Team** -> **Service Users** and delete the token, or delete the service user.

## Linking the Account from the Hub

**1. Navigate to the Hub**

Use one of the three [Linking Account Methods](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md) to access the Hub.

**2. Fill out the fields**

Fill out the following fields using details from your provider:

<ul>
  <li>**Access Token**</li>
  <li>**Server URL** (Optional)</li>
</ul>

**3. Connect**

<ul>
  <li>Click **Connect**</li>
  <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
  <li>Once authorization is successful, you will see a confirmation popup</li>
</ul>

If the account linking is successful, you will see the newly linked account on your [Accounts](https://app.stackone.com/accounts) page.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.