GET/api/identity-providers
List all Identity Providers
Returns a list of all identity providers configured for the account
Request
GET
/api/identity-providerscurl -X GET https://api.netbird.io/api/identity-providers \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
Response
[
{
"id": "ch8i4ug6lnn4g9hqv7l0",
"type": "oidc",
"name": "My OIDC Provider",
"issuer": "https://accounts.google.com",
"client_id": "123456789.apps.googleusercontent.com"
}
]
POST/api/identity-providers
Create an Identity Provider
Creates a new identity provider configuration
Request-Body Parameters
- Name
type- Type
- string
- Required
- required
- Enum
- Description
Type of identity provider
- Name
name- Type
- string
- Required
- required
- Enum
- Description
Human-readable name for the identity provider
- Name
issuer- Type
- string
- Required
- required
- Enum
- Description
OIDC issuer URL
- Name
client_id- Type
- string
- Required
- required
- Enum
- Description
OAuth2 client ID
- Name
client_secret- Type
- string
- Required
- required
- Enum
- Description
OAuth2 client secret
Request
POST
/api/identity-providerscurl -X POST https://api.netbird.io/api/identity-providers \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"type": "oidc",
"name": "My OIDC Provider",
"issuer": "https://accounts.google.com",
"client_id": "123456789.apps.googleusercontent.com",
"client_secret": "secret123"
}'
Response
{
"id": "ch8i4ug6lnn4g9hqv7l0",
"type": "oidc",
"name": "My OIDC Provider",
"issuer": "https://accounts.google.com",
"client_id": "123456789.apps.googleusercontent.com"
}
GET/api/identity-providers/{idpId}
Retrieve an Identity Provider
Get information about a specific identity provider
Path Parameters
- Name
idpId- Type
- string
- Required
- required
- Enum
- Description
The unique identifier of an identity provider
Request
GET
/api/identity-providers/{idpId}curl -X GET https://api.netbird.io/api/identity-providers/{idpId} \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
Response
{
"id": "ch8i4ug6lnn4g9hqv7l0",
"type": "oidc",
"name": "My OIDC Provider",
"issuer": "https://accounts.google.com",
"client_id": "123456789.apps.googleusercontent.com"
}
PUT/api/identity-providers/{idpId}
Update an Identity Provider
Update an existing identity provider configuration
Path Parameters
- Name
idpId- Type
- string
- Required
- required
- Enum
- Description
The unique identifier of an identity provider
Request-Body Parameters
- Name
type- Type
- string
- Required
- required
- Enum
- Description
Type of identity provider
- Name
name- Type
- string
- Required
- required
- Enum
- Description
Human-readable name for the identity provider
- Name
issuer- Type
- string
- Required
- required
- Enum
- Description
OIDC issuer URL
- Name
client_id- Type
- string
- Required
- required
- Enum
- Description
OAuth2 client ID
- Name
client_secret- Type
- string
- Required
- required
- Enum
- Description
OAuth2 client secret
Request
PUT
/api/identity-providers/{idpId}curl -X PUT https://api.netbird.io/api/identity-providers/{idpId} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"type": "oidc",
"name": "My OIDC Provider",
"issuer": "https://accounts.google.com",
"client_id": "123456789.apps.googleusercontent.com",
"client_secret": "secret123"
}'
Response
{
"id": "ch8i4ug6lnn4g9hqv7l0",
"type": "oidc",
"name": "My OIDC Provider",
"issuer": "https://accounts.google.com",
"client_id": "123456789.apps.googleusercontent.com"
}
DELETE/api/identity-providers/{idpId}
Delete an Identity Provider
Delete an identity provider configuration
Path Parameters
- Name
idpId- Type
- string
- Required
- required
- Enum
- Description
The unique identifier of an identity provider
Request
DELETE
/api/identity-providers/{idpId}curl -X DELETE https://api.netbird.io/api/identity-providers/{idpId} \
-H 'Authorization: Token <TOKEN>'