Skip to content

cmem_client.models.keycloak_client¤

Keycloak client models.

An OpenID Connect client is the service account a machine authenticates with. The clients of the configured realm are the items of client.client_accounts, keyed by their client_id.

Classes:

  • KeycloakClient – A Keycloak OpenID Connect client in the Corporate Memory realm.

KeycloakClient¤

Bases: Model, ReadRepositoryItem

A Keycloak OpenID Connect client in the Corporate Memory realm.

Attributes:

  • id (str) – Internal Keycloak identifier of the client, a UUID. Needed by the Keycloak admin API, but not the key of the repository.
  • client_id (str) – Client identifier used when authenticating, e.g. cmem-service-account. This is the key of the repository.
  • description (str) – Description of the client as maintained in Keycloak.
  • protocol (str) – Authentication protocol of the client, e.g. openid-connect.
  • secret (str | None) – Client secret, only present if the deployment returns it and the requesting account is allowed to read it.

Functions:

  • get_id – Get the clientId as the unique identifier.

client_id¤

client_id: str = Field(alias='clientId')

description¤

description: str = ''

get_id¤

get_id()

Get the clientId as the unique identifier.

id¤

id: str

model_config¤

model_config = ConfigDict(extra='allow', populate_by_name=True)

protocol¤

protocol: str = ''

secret¤

secret: str | None = None

Comments