Authentication

You'll need to authenticate your requests to access any of the endpoints in the NetBird API. In this guide, we'll look at how authentication works. NetBird offers two ways to authenticate your API requests: OAuth2 and personal access tokens (PAT).

OAuth2 with bearer token

When establishing a connection using OAuth2, you will need your access token — you can retrieve one from your IDP manager. Here's how to add the token to the request header using cURL:

curl https://api.netbird.io/api/users \
  -H "Authorization: Bearer {token}"

Always keep your token safe and reset it if you suspect it has been compromised.

Using personal access tokens

When establishing a connection using PATs, you will need your access token — you can create one in the NetBird dashboard under User settings. It is recommended to use service users for all organization wide flows calling the API. Here's how to add the token to the request header using cURL:

curl https://api.netbird.io/api/users \
  -H "Authorization: Token {token}"

Always keep your token safe and reset it if you suspect it has been compromised.