Ana içeriğe geç

Delete OIDC Provider

Endpoint

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

Authentication

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request

Headers

HeaderValueRequired
AuthorizationBearer {token}Yes

Path Parameters

ParameterTypeRequiredDescription
projectNamestringYesProject name
namestringYesOIDC provider name to delete

Query Parameters

None.

Response

Success Response (204 No Content)

Empty body.

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)

Returned when the provider is still referenced by a JWT, OAuth 2, or OIDC Authentication policy — either as its Identity Role Group source or (for the OIDC Authentication policy) as its Shared OIDC Provider. The referencing policy must be repointed or removed first.

{
"type": "https://apinizer.com/problem-with-message",
"title": "Bad Request",
"status": 400,
"detail": "This OIDC provider is referenced by 2 policies and cannot be deleted — repoint or remove the referencing policy first.",
"path": "/apiops/projects/MyProject/oidc-providers/keycloak-main/",
"message": "error.inUseByPolicy",
"params": "authenticationOidcProvider"
}

cURL Example

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

Notes and Warnings

  • Policy-usage guard: unlike LDAP/Database/API providers, an OIDC provider referenced by a live policy cannot be deleted at all — deleting it would leave the policy pointing at a dangling reference, and every request through it would fail closed. Repoint or delete the referencing policy first.
  • Credential release: once the policy-usage guard passes, any Credential records that were synchronized from this provider (Keycloak vendor only) are released to manual management rather than left pointing at a deleted provider.
  • Undeploy: the provider is undeployed from every currently running environment in the project.

Permissions

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