Red Hat · Schema

Client

A client application registered in a Keycloak realm for authentication.

CloudContainersEnterpriseHybrid CloudKubernetesLinuxOpen Source

Properties

Name	Type	Description
id	string	The unique identifier of the client.
clientId	string	The client identifier used in authentication flows.
name	string	The display name of the client.
description	string	A description of the client.
enabled	boolean	Whether the client is enabled.
protocol	string	The authentication protocol.
publicClient	boolean	Whether the client is public (no client secret).
rootUrl	string	The root URL of the client application.
redirectUris	array	Allowed redirect URIs after authentication.
webOrigins	array	Allowed web origins for CORS.
serviceAccountsEnabled	boolean	Whether service accounts are enabled.
authorizationServicesEnabled	boolean	Whether authorization services are enabled.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Client",
  "type": "object",
  "description": "A client application registered in a Keycloak realm for authentication.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the client."
    },
    "clientId": {
      "type": "string",
      "description": "The client identifier used in authentication flows."
    },
    "name": {
      "type": "string",
      "description": "The display name of the client."
    },
    "description": {
      "type": "string",
      "description": "A description of the client."
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the client is enabled."
    },
    "protocol": {
      "type": "string",
      "description": "The authentication protocol."
    },
    "publicClient": {
      "type": "boolean",
      "description": "Whether the client is public (no client secret)."
    },
    "rootUrl": {
      "type": "string",
      "description": "The root URL of the client application."
    },
    "redirectUris": {
      "type": "array",
      "description": "Allowed redirect URIs after authentication."
    },
    "webOrigins": {
      "type": "array",
      "description": "Allowed web origins for CORS."
    },
    "serviceAccountsEnabled": {
      "type": "boolean",
      "description": "Whether service accounts are enabled."
    },
    "authorizationServicesEnabled": {
      "type": "boolean",
      "description": "Whether authorization services are enabled."
    }
  }
}