Retrieve an Identity Provider | NetBird Full API Reference + Read-Only MCP Prototype

1 parameter

idpIdstringrequired

The unique identifier of an identity provider

5 status codes

200An Identity Provider object

client_idstringrequired

OAuth2 client ID

idstringoptional

Identity provider ID

issuerstringrequired

OIDC issuer URL

namestringrequired

Human-readable name for the identity provider

typestringrequired

Type of identity provider

Allowed:oidczitadelentragoogleoktapocketidmicrosoftadfs

400Bad Request

401Requires authentication

403Forbidden

500Internal Server Error

Error handling

A 400 is returned: Bad Request. A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error.

import { NetBirdManagementAPIUnofficialOctriFullPreview } from "netbird-management-api-|-unofficial-octri-full-preview";

const client = new NetBirdManagementAPIUnofficialOctriFullPreview({
  baseUrl: "https://api.netbird.io",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.identityProviders.get({ idpId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "client_id": "123456789.apps.googleusercontent.com",
  "id": "ch8i4ug6lnn4g9hqv7l0",
  "issuer": "https://accounts.google.com",
  "name": "My OIDC Provider",
  "type": "oidc"
}

Request

Response

Errors