NetBird Full API Reference + Read-Only MCP Prototype
POST/api/identity-providers

Create an identity provider

Creates a new identity provider configuration. Provide the provider type, name, issuer URL, OAuth2 client ID, and client secret to configure the provider.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

Identity provider configuration details.

client_idstringrequired
OAuth2 client ID
client_secretstringrequired
OAuth2 client secret
issuerstringrequired
OIDC issuer URL
namestringrequired
Human-readable name for the identity provider
typestringrequired
Type of identity provider
Allowed:oidczitadelentragoogleoktapocketidmicrosoftadfs

5 status codes
200Returns the created identity provider object, including its `id`, `type`, `name`, `issuer`, and `client_id`.
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
400Returned when the request is invalid.
401Returned when the request does not include valid authentication.
403Returned when the authenticated user is not permitted to create an identity provider.
500Returned when an internal server error occurs.

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the request does not include valid authentication, a 403 when the authenticated user is not permitted to create an identity provider, and a 500 when an internal server error occurs. type, name, issuer, client_id, and client_secret are required; type must be one of oidc, zitadel, entra, google, okta, pocketid, microsoft, or adfs.