IDP - NetBird API

POST/api/integrations/scim-idp

Create SCIM IDP Integration

Creates a new SCIM integration

Request-Body Parameters

Name
prefix
Type
string
Required
required
Enum
Description
The connection prefix used for the SCIM provider
Name
provider
Type
string
Required
required
Enum
Description
Name of the SCIM identity provider
Name
group_prefixes
Type
string[]
Required
optional
Enum
Description
List of start_with string patterns for groups to sync
Name
user_group_prefixes
Type
string[]
Required
optional
Enum
Description
List of start_with string patterns for groups which users to sync

Request

POST

/api/integrations/scim-idp

curl -X POST https://api.netbird.io/api/integrations/scim-idp \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
  "prefix": {
    "type": "string",
    "description": "The connection prefix used for the SCIM provider"
  },
  "provider": {
    "type": "string",
    "description": "Name of the SCIM identity provider"
  },
  "group_prefixes": [
    "Engineering",
    "Sales"
  ],
  "user_group_prefixes": [
    "Users"
  ]
}'

Response

{
  "id": 123,
  "enabled": true,
  "provider": {
    "type": "string",
    "description": "Name of the SCIM identity provider"
  },
  "group_prefixes": [
    "Engineering",
    "Sales"
  ],
  "user_group_prefixes": [
    "Users"
  ],
  "auth_token": "nbs_abc***********************************",
  "last_synced_at": "2023-05-15T10:30:00Z"
}

GET/api/integrations/scim-idp

Get All SCIM IDP Integrations

Retrieves all SCIM IDP integrations for the authenticated account

Request

GET

/api/integrations/scim-idp

curl -X GET https://api.netbird.io/api/integrations/scim-idp \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'

Response

[
  {
    "id": 123,
    "enabled": true,
    "provider": {
      "type": "string",
      "description": "Name of the SCIM identity provider"
    },
    "group_prefixes": [
      "Engineering",
      "Sales"
    ],
    "user_group_prefixes": [
      "Users"
    ],
    "auth_token": "nbs_abc***********************************",
    "last_synced_at": "2023-05-15T10:30:00Z"
  }
]

GET/api/integrations/scim-idp/{id}

Get SCIM IDP Integration

Retrieves an SCIM IDP integration by ID.

Request

GET

/api/integrations/scim-idp/{id}

curl -X GET https://api.netbird.io/api/integrations/scim-idp/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'

Response

{
  "id": 123,
  "enabled": true,
  "provider": {
    "type": "string",
    "description": "Name of the SCIM identity provider"
  },
  "group_prefixes": [
    "Engineering",
    "Sales"
  ],
  "user_group_prefixes": [
    "Users"
  ],
  "auth_token": "nbs_abc***********************************",
  "last_synced_at": "2023-05-15T10:30:00Z"
}

PUT/api/integrations/scim-idp/{id}

Update SCIM IDP Integration

Updates an existing SCIM IDP Integration.

Request-Body Parameters

Name
enabled
Type
boolean
Required
optional
Enum
Description
Indicates whether the integration is enabled
Name
group_prefixes
Type
string[]
Required
optional
Enum
Description
List of start_with string patterns for groups to sync
Name
user_group_prefixes
Type
string[]
Required
optional
Enum
Description
List of start_with string patterns for groups which users to sync

Request

PUT

/api/integrations/scim-idp/{id}

curl -X PUT https://api.netbird.io/api/integrations/scim-idp/{id} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
  "enabled": true,
  "group_prefixes": [
    "Engineering",
    "Sales"
  ],
  "user_group_prefixes": [
    "Users"
  ]
}'

Response

{
  "id": 123,
  "enabled": true,
  "provider": {
    "type": "string",
    "description": "Name of the SCIM identity provider"
  },
  "group_prefixes": [
    "Engineering",
    "Sales"
  ],
  "user_group_prefixes": [
    "Users"
  ],
  "auth_token": "nbs_abc***********************************",
  "last_synced_at": "2023-05-15T10:30:00Z"
}

DELETE/api/integrations/scim-idp/{id}

Delete SCIM IDP Integration

Deletes an SCIM IDP integration by ID.

Request

DELETE

/api/integrations/scim-idp/{id}

curl -X DELETE https://api.netbird.io/api/integrations/scim-idp/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'

Response

{}

POST/api/integrations/scim-idp/{id}/token

Regenerate SCIM Token

Regenerates the SCIM API token for an SCIM IDP integration.

Request

POST

/api/integrations/scim-idp/{id}/token

curl -X POST https://api.netbird.io/api/integrations/scim-idp/{id}/token \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'

Response

{
  "auth_token": "nbs_F3f0d..."
}

GET/api/integrations/scim-idp/{id}/logs

Get SCIM Integration Sync Logs

Retrieves synchronization logs for a SCIM IDP integration.

Request

GET

/api/integrations/scim-idp/{id}/logs

curl -X GET https://api.netbird.io/api/integrations/scim-idp/{id}/logs \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'

Response

[
  {
    "id": 123,
    "level": "info",
    "timestamp": "2023-05-15T10:30:00Z",
    "message": "Successfully synchronized users and groups"
  }
]