> ## 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.

# NetBird

> How to set up the NetBird connector, plus the actions that are available.

![NetBird](https://stackone-logos.com/api/netbird/filled/svg)

Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/netbird/changelog.md)

[15 actions](#actions) · 1 auth method

Security
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> **[Connector Profile · Access Token](https://docs.stackone.com/connectors/netbird/guides/connector-profile/access-token.md)**
>
> No app registration required. Uses an access token of a NetBird service user or person, for NetBird Cloud or a self-host...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · Access Token](https://docs.stackone.com/connectors/netbird/guides/link-account/access-token.md)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

15 actions

ActionDescription

List Accounts`netbird_list_accounts`

Get the NetBird account the access token belongs to.

List Audit Events`netbird_list_audit_events`

List the audit events of the connected NetBird account.

List Groups`netbird_list_groups`

List the groups of the connected NetBird account.

Get Group`netbird_get_group`

Get one group of the connected NetBird account.

Get Unified Credentials`netbird_unified_get_me`

Get the current NetBird connection's unified credentials and identity.

List Unified Groups`netbird_unified_list_groups`

List unified groups in a NetBird account.

Get Unified Group`netbird_unified_get_group`

Get a unified NetBird group by ID.

List Unified Roles`netbird_unified_list_roles`

List the built-in user roles of NetBird.

Get Unified Role`netbird_unified_get_role`

Get a unified NetBird role by ID.

List Unified Users`netbird_unified_list_users`

List unified users in a NetBird account.

Get Unified User`netbird_unified_get_user`

Get a unified NetBird user by ID.

List Users`netbird_list_users`

List the users and service users of the connected NetBird account.

Get Current User`netbird_get_current_user`

Get the NetBird user that owns the access token, with its permissions when NetBird returns them.

List User Invites`netbird_list_user_invites`

List the user invites of a NetBird account that uses the embedded identity provider.

List User Access Tokens`netbird_list_user_tokens`

List the access tokens of one NetBird user.


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