Get OIDC Provider

Endpoint

GET /apiops/projects/{projectName}/oidc-providers/{name}/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
name	string	Yes	OIDC provider name

Query Parameters

None.

Response

Success Response (200 OK)

The response body is a raw JSON object — see the OIDC Provider Object field reference on the List endpoint page for every field.

{
  "name": "keycloak-main",
  "description": "Primary Keycloak realm for customer-facing APIs",
  "vendorType": "KEYCLOAK",
  "issuerUrl": "https://keycloak.example.com/realms/acme",
  "discoveryUrl": null,
  "autoDiscover": true,
  "tokenEndpoint": "https://keycloak.example.com/realms/acme/protocol/openid-connect/token",
  "introspectionEndpoint": "https://keycloak.example.com/realms/acme/protocol/openid-connect/token/introspect",
  "userInfoEndpoint": "https://keycloak.example.com/realms/acme/protocol/openid-connect/userinfo",
  "jwksEndpoint": "https://keycloak.example.com/realms/acme/protocol/openid-connect/certs",
  "endSessionEndpoint": "https://keycloak.example.com/realms/acme/protocol/openid-connect/logout",
  "clientId": "apinizer-gateway",
  "clientSecretSet": true,
  "clientAuthMethod": "CLIENT_SECRET_BASIC",
  "validationMode": "OFFLINE",
  "jwksSourceMode": "DISCOVERY",
  "staticJwksJson": null,
  "certificateName": null,
  "jwksCacheTimeoutSeconds": 3600,
  "allowedSignatureAlgorithms": ["RS256", "RS384", "RS512", "ES256"],
  "validateIssuer": true,
  "expectedIssuer": null,
  "validateAudience": true,
  "expectedAudience": [],
  "maxClockSkewSeconds": 30,
  "connectionTimeoutSeconds": 10,
  "readTimeoutSeconds": 10,
  "usernameClaimPath": "preferred_username",
  "emailClaimPath": "email",
  "fullNameClaimPath": "name",
  "rolesClaimPath": null,
  "groupsClaimPath": null,
  "requireMatchingCredential": true,
  "roleSource": "SYNCED_CREDENTIAL",
  "syncEnabled": true,
  "realm": "acme",
  "adminBaseUrl": "https://keycloak.example.com",
  "syncPageSize": 250,
  "groupSyncEnabled": true,
  "roleSyncSource": "REALM_ROLES",
  "syncClientId": "apinizer-sync"
}

Error Response (404 Not Found)

Returned with an empty body when no provider with the given name exists in the project.

Error Response (400 Bad Request)

{
  "type": "https://apinizer.com/problem-with-message",
  "title": "Bad Request",
  "status": 400,
  "detail": "Project (MyProject) is not found!",
  "path": "/apiops/projects/MyProject/oidc-providers/keycloak-main/",
  "message": "error.http.400"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/oidc-providers/keycloak-main/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Permissions

• User must have IDENTITY + VIEW permission in the project.

Related Documentation

• List OIDC Providers - Get all providers for a project
• Update OIDC Provider - Update a provider
• OIDC Provider - Admin guide field reference