Get an application
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal/applications/example';
const options = {
method: 'GET',
headers: {'API-Version': '2026-06-01.beta', 'API-Key': '<API-Key>'}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request GET \
--url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal/applications/example \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta'Required scope: applications:read
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.
Example
customer-portalOAuth 2.0 client identifier. Used as the stable resource identifier in this API and in Keycloak realm URLs.
Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”The request has succeeded.
A Keycloak client (application) registered in a realm.
object
OAuth 2.0 client identifier. Stable resource identifier for this API.
Human-readable display name.
Optional description of the application.
OAuth 2.0 client type.
Authentication protocol.
Whether the application is active.
Allowed redirect URIs for authorization-code flows. Required for authorization_code grant.
Enabled OAuth 2.0 grant types.
Whether PKCE (Proof Key for Code Exchange) is required.
Whether user consent is required before issuing tokens.
Whether this application has a service account for machine-to-machine flows. Derived from the client_credentials grant type.
Client secret. Present only immediately after creation or secret rotation; store it securely as it will not be returned again.
Browser origins allowed to call this application (CORS). ["*"] allows any origin.
URIs a user may be redirected to after signing out. Falls back to redirect_uris when empty.
Root URL. Prefixed to any relative redirect URI.
Home URL. Where Keycloak sends a user opening the application from the account console.
Admin URL. Where Keycloak sends back-channel logout and admin callbacks.
SAML-specific configuration. Present only when protocol is saml.
object
SAML entity ID (SP Entity ID / Issuer).
Assertion Consumer Service URLs (ACS endpoints).
Single Logout Service URL.
SAML NameID format.
Whether to sign SAML documents.
Whether to sign SAML assertions.
Whether to encrypt SAML assertions.
Whether to force re-authentication on each request.
Whether to force HTTP POST binding for responses.
Whether to include the AuthnStatement in assertions.
Static SAML attribute statements to include in assertions. Keys are attribute names; values are attribute values.
object
Example
{
"type": "confidential",
"protocol": "openid-connect",
"status": "active",
"grant_types": [
"authorization_code"
],
"saml_config": {
"name_id_format": "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified"
}
}Access is unauthorized.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}The server cannot find the requested resource.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}