Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Keycloak Identity Providers API

Manage identity providers for federated authentication

Keycloak Identity Providers API is one of 6 APIs that Keycloak publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Identity Providers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a JSON-LD context, and 3 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 26.0.0.

Requests are made against a single base URL, https://{host}/admin/realms.

5 operations 2 paths 1 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
26.0.0
Server
https://{host}/admin/realms
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

Keycloak Identity Providers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Access token obtained from the Keycloak token endpoint. Use the master realm admin credentials or a service account with appropriate realm-management roles.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Identity Providers 5

Manage identity providers for federated authentication

GET
/{realm}/identity-provider/instances
Keycloak List identity providers
getIdentityProviders 1 param → 200
POST
/{realm}/identity-provider/instances
Keycloak Create an identity provider
createIdentityProvider 1 param body → 201
GET
/{realm}/identity-provider/instances/{alias}
Keycloak Get an identity provider
getIdentityProvider 2 params → 200404
PUT
/{realm}/identity-provider/instances/{alias}
Keycloak Update an identity provider
updateIdentityProvider 2 params body → 204
DELETE
/{realm}/identity-provider/instances/{alias}
Keycloak Delete an identity provider
deleteIdentityProvider 2 params → 204

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is IdentityProviderRepresentation (13 properties). Each schema is shown below with its type and property counts.

IdentityProviderRepresentation
object
Representation of a federated identity provider
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keycloak-identity-providers-api-openapi.yml Raw ↑

Other APIs Keycloak publishes across the network.

Keycloak Clients API
Keycloak Groups API
Keycloak Realms API
Keycloak Roles API
Keycloak Users API