Uses of Class
org.keycloak.representations.idm.ClientRepresentation

Packages that use ClientRepresentation

Package	Description
org.keycloak.admin.client.resource
org.keycloak.exportimport
org.keycloak.exportimport.util
org.keycloak.models.utils
org.keycloak.partialimport
org.keycloak.protocol
org.keycloak.protocol.docker
org.keycloak.protocol.oid4vc
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.utils
org.keycloak.protocol.saml
org.keycloak.protocol.saml.clientregistration
org.keycloak.representations.idm
org.keycloak.services.clientpolicy.context
org.keycloak.services.clientpolicy.executor
org.keycloak.services.clientregistration
org.keycloak.services.clientregistration.oidc
org.keycloak.services.managers
org.keycloak.services.resources.account.resources
org.keycloak.services.resources.admin
org.keycloak.services.util

Uses of ClientRepresentation in org.keycloak.admin.client.resource

Methods in org.keycloak.admin.client.resource that return ClientRepresentation

Modifier and Type	Method	Description
ClientRepresentation	RealmResource.convertClientDescription(String description)
ClientRepresentation	ClientResource.regenerateRegistrationAccessToken()	Generate a new registration access token for the client
ClientRepresentation	ClientResource.toRepresentation()

Methods in org.keycloak.admin.client.resource that return types with arguments of type ClientRepresentation

Modifier and Type	Method	Description
List<ClientRepresentation>	ClientsResource.findAll()
List<ClientRepresentation>	ClientsResource.findAll(boolean viewableOnly)
List<ClientRepresentation>	ClientsResource.findAll(String clientId, Boolean viewableOnly, Boolean search, Integer firstResult, Integer maxResults)
List<ClientRepresentation>	ClientsResource.findByClientId(String clientId)
List<ClientRepresentation>	ClientsResource.query(String searchQuery)

Methods in org.keycloak.admin.client.resource with parameters of type ClientRepresentation

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	ClientsResource.create(ClientRepresentation clientRepresentation)
void	ClientResource.update(ClientRepresentation clientRepresentation)

Uses of ClientRepresentation in org.keycloak.exportimport

Methods in org.keycloak.exportimport that return ClientRepresentation

Modifier and Type	Method	Description
ClientRepresentation	ClientDescriptionConverter.convertToInternal(String description)
ClientRepresentation	KeycloakClientDescriptionConverter.convertToInternal(String description)

Uses of ClientRepresentation in org.keycloak.exportimport.util

Methods in org.keycloak.exportimport.util that return ClientRepresentation

Modifier and Type	Method	Description
static ClientRepresentation	ExportUtils.exportClient(KeycloakSession session, ClientModel client)	Full export of application including claims and secret

Uses of ClientRepresentation in org.keycloak.models.utils

Methods in org.keycloak.models.utils that return ClientRepresentation

Modifier and Type	Method	Description
protected static ClientRepresentation	StripSecretsUtils.stripClient(ClientRepresentation rep)
static ClientRepresentation	ModelToRepresentation.toRepresentation(ClientModel clientModel, KeycloakSession session)

Methods in org.keycloak.models.utils with parameters of type ClientRepresentation

Modifier and Type	Method	Description
static ClientModel	RepresentationToModel.createClient(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep)	Does not create scope or role mappings!
static ClientModel	RepresentationToModel.createClient(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep, Map<String,String> mappedFlows)
static void	RepresentationToModel.importAuthorizationSettings(ClientRepresentation clientRepresentation, ClientModel client, KeycloakSession session)
protected static ClientRepresentation	StripSecretsUtils.stripClient(ClientRepresentation rep)
static void	RepresentationToModel.updateClient(ClientRepresentation rep, ClientModel resource, KeycloakSession session)
static void	RepresentationToModel.updateClientProtocolMappers(ClientRepresentation rep, ClientModel resource)
static void	RepresentationToModel.updateClientScopes(ClientRepresentation resourceRep, ClientModel client)

Uses of ClientRepresentation in org.keycloak.partialimport

Methods in org.keycloak.partialimport that return types with arguments of type ClientRepresentation

Modifier and Type	Method	Description
List<ClientRepresentation>	ClientsPartialImport.getRepList(PartialImportRepresentation partialImportRep)

Methods in org.keycloak.partialimport with parameters of type ClientRepresentation

Modifier and Type	Method	Description
void	ClientsPartialImport.create(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep)
boolean	ClientsPartialImport.exists(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep)
String	ClientsPartialImport.existsMessage(RealmModel realm, ClientRepresentation clientRep)
String	ClientsPartialImport.getModelId(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep)
String	ClientsPartialImport.getName(ClientRepresentation clientRep)
void	ClientsPartialImport.remove(RealmModel realm, KeycloakSession session, ClientRepresentation clientRep)

Uses of ClientRepresentation in org.keycloak.protocol

Methods in org.keycloak.protocol with parameters of type ClientRepresentation

Modifier and Type	Method	Description
void	LoginProtocolFactory.setupClientDefaults(ClientRepresentation rep, ClientModel newClient)	Setup default values for new clients.

Uses of ClientRepresentation in org.keycloak.protocol.docker

Methods in org.keycloak.protocol.docker with parameters of type ClientRepresentation

Modifier and Type	Method	Description
void	DockerAuthV2ProtocolFactory.setupClientDefaults(ClientRepresentation rep, ClientModel newClient)

Uses of ClientRepresentation in org.keycloak.protocol.oid4vc

Methods in org.keycloak.protocol.oid4vc that return ClientRepresentation

Modifier and Type	Method	Description
protected static ClientRepresentation	OID4VCClientRegistrationProvider.toClientRepresentation(OID4VCClient oid4VCClient)	Translate an incoming OID4VCClient into a keycloak native ClientRepresentation.

Methods in org.keycloak.protocol.oid4vc with parameters of type ClientRepresentation

Modifier and Type	Method	Description
void	OID4VCLoginProtocolFactory.setupClientDefaults(ClientRepresentation rep, ClientModel newClient)
static void	OID4VCClientRegistrationProvider.validate(ClientRepresentation client)	Validates the clientRepresentation to fulfill the requirement of an OID4VC client

Uses of ClientRepresentation in org.keycloak.protocol.oidc

Fields in org.keycloak.protocol.oidc declared as ClientRepresentation

Modifier and Type	Field	Description
protected final ClientRepresentation	AbstractClientConfigWrapper.clientRep

Methods in org.keycloak.protocol.oidc that return ClientRepresentation

Modifier and Type	Method	Description
ClientRepresentation	OIDCClientDescriptionConverter.convertToInternal(String description)

Methods in org.keycloak.protocol.oidc with parameters of type ClientRepresentation

Modifier and Type	Method	Description
static OIDCAdvancedConfigWrapper	OIDCAdvancedConfigWrapper.fromClientRepresentation(ClientRepresentation clientRep)
static OIDCClientSecretConfigWrapper	OIDCClientSecretConfigWrapper.fromClientRepresentation(ClientRepresentation clientRep)
void	OIDCLoginProtocolFactory.setupClientDefaults(ClientRepresentation rep, ClientModel newClient)
void	OIDCClientSecretConfigWrapper.updateClientRepresentationAttributes(ClientRepresentation rep)

Constructors in org.keycloak.protocol.oidc with parameters of type ClientRepresentation

Modifier	Constructor	Description
protected	AbstractClientConfigWrapper(ClientModel clientModel, ClientRepresentation clientRep)

Uses of ClientRepresentation in org.keycloak.protocol.oidc.utils

Methods in org.keycloak.protocol.oidc.utils with parameters of type ClientRepresentation

Modifier and Type	Method	Description
static List<ProtocolMapperRepresentation>	PairwiseSubMapperUtils.getPairwiseSubMappers(ClientRepresentation client)

Uses of ClientRepresentation in org.keycloak.protocol.saml

Methods in org.keycloak.protocol.saml that return ClientRepresentation

Modifier and Type	Method	Description
ClientRepresentation	EntityDescriptorDescriptionConverter.convertToInternal(String description)

Methods in org.keycloak.protocol.saml with parameters of type ClientRepresentation

Modifier and Type	Method	Description
void	SamlProtocolFactory.setupClientDefaults(ClientRepresentation clientRep, ClientModel newClient)

Uses of ClientRepresentation in org.keycloak.protocol.saml.clientregistration

Constructors in org.keycloak.protocol.saml.clientregistration with parameters of type ClientRepresentation

Modifier	Constructor	Description
	EntityDescriptorClientRegistrationContext(KeycloakSession session, ClientRepresentation client, ClientRegistrationProvider provider)

Uses of ClientRepresentation in org.keycloak.representations.idm

Subclasses of ClientRepresentation in org.keycloak.representations.idm

Modifier and Type	Class	Description
class	ApplicationRepresentation	Deprecated.
class	OAuthClientRepresentation	Deprecated.

Fields in org.keycloak.representations.idm with type parameters of type ClientRepresentation

Modifier and Type	Field	Description
protected List<ClientRepresentation>	PartialImportRepresentation.clients
protected List<ClientRepresentation>	RealmRepresentation.clients

Methods in org.keycloak.representations.idm that return types with arguments of type ClientRepresentation

Modifier and Type	Method	Description
List<ClientRepresentation>	PartialImportRepresentation.getClients()
List<ClientRepresentation>	RealmRepresentation.getClients()

Method parameters in org.keycloak.representations.idm with type arguments of type ClientRepresentation

Modifier and Type	Method	Description
void	PartialImportRepresentation.setClients(List<ClientRepresentation> clients)
void	RealmRepresentation.setClients(List<ClientRepresentation> clients)

Uses of ClientRepresentation in org.keycloak.services.clientpolicy.context

Methods in org.keycloak.services.clientpolicy.context that return ClientRepresentation

Modifier and Type	Method	Description
ClientRepresentation	AdminClientRegisterContext.getProposedClientRepresentation()
ClientRepresentation	AdminClientUpdateContext.getProposedClientRepresentation()
ClientRepresentation	AdminClientUpdatedContext.getProposedClientRepresentation()
default ClientRepresentation	ClientCRUDContext.getProposedClientRepresentation()	returns ClientRepresentation for creating the new client or updating the existing client.
ClientRepresentation	DynamicClientRegisterContext.getProposedClientRepresentation()
ClientRepresentation	DynamicClientUpdateContext.getProposedClientRepresentation()

Constructors in org.keycloak.services.clientpolicy.context with parameters of type ClientRepresentation

Modifier	Constructor	Description
	AdminClientRegisterContext(ClientRepresentation proposedClientRepresentation, AdminAuth adminAuth)
	AdminClientUpdateContext(ClientRepresentation proposedClientRepresentation, ClientModel targetClient, AdminAuth adminAuth)
	AdminClientUpdatedContext(ClientRepresentation roposedClientRepresentation, ClientModel updatedClient, AdminAuth adminAuth)
	ClientSecretRotationContext(ClientRepresentation proposedClientRepresentation, ClientModel targetClient, String currentSecret)

Uses of ClientRepresentation in org.keycloak.services.clientpolicy.executor

Methods in org.keycloak.services.clientpolicy.executor with parameters of type ClientRepresentation

Modifier and Type	Method	Description
void	ConsentRequiredExecutor.beforeUpdate(ClientModel clientToBeUpdated, ClientRepresentation proposedClient)

Uses of ClientRepresentation in org.keycloak.services.clientregistration

Fields in org.keycloak.services.clientregistration declared as ClientRepresentation

Modifier and Type	Field	Description
protected final ClientRepresentation	AbstractClientRegistrationContext.client

Methods in org.keycloak.services.clientregistration that return ClientRepresentation

Modifier and Type	Method	Description
ClientRepresentation	AbstractClientRegistrationProvider.create(ClientRegistrationContext context)
ClientRepresentation	AbstractClientRegistrationProvider.get(ClientModel client)
ClientRepresentation	AbstractClientRegistrationContext.getClient()
ClientRepresentation	ClientRegistrationContext.getClient()
ClientRepresentation	AbstractClientRegistrationProvider.update(String clientId, ClientRegistrationContext context)

Methods in org.keycloak.services.clientregistration with parameters of type ClientRepresentation

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	DefaultClientRegistrationProvider.createDefault(ClientRepresentation client)
jakarta.ws.rs.core.Response	DefaultClientRegistrationProvider.updateDefault(String clientId, ClientRepresentation client)
void	AbstractClientRegistrationProvider.validateClient(ClientRepresentation clientRep, boolean create)

Constructors in org.keycloak.services.clientregistration with parameters of type ClientRepresentation

Modifier	Constructor	Description
	AbstractClientRegistrationContext(KeycloakSession session, ClientRepresentation client, ClientRegistrationProvider provider)
	DefaultClientRegistrationContext(KeycloakSession session, ClientRepresentation client, ClientRegistrationProvider provider)

Uses of ClientRepresentation in org.keycloak.services.clientregistration.oidc

Methods in org.keycloak.services.clientregistration.oidc that return ClientRepresentation

Modifier and Type	Method	Description
static ClientRepresentation	DescriptionConverter.toInternal(KeycloakSession session, OIDCClientRepresentation clientOIDC)

Methods in org.keycloak.services.clientregistration.oidc with parameters of type ClientRepresentation

Modifier and Type	Method	Description
static OIDCClientRepresentation	DescriptionConverter.toExternalResponse(KeycloakSession session, ClientRepresentation client, URI uri)

Constructors in org.keycloak.services.clientregistration.oidc with parameters of type ClientRepresentation

Modifier	Constructor	Description
	OIDCClientRegistrationContext(KeycloakSession session, ClientRepresentation client, ClientRegistrationProvider provider, OIDCClientRepresentation oidcRep)

Uses of ClientRepresentation in org.keycloak.services.managers

Methods in org.keycloak.services.managers with parameters of type ClientRepresentation

Modifier and Type	Method	Description
void	ClientManager.clientIdChanged(ClientModel client, ClientRepresentation newClientRepresentation)
static ClientModel	ClientManager.createClient(KeycloakSession session, RealmModel realm, ClientRepresentation rep)	Should not be called from an import.

Uses of ClientRepresentation in org.keycloak.services.resources.account.resources

Subclasses of ClientRepresentation in org.keycloak.services.resources.account.resources

Modifier and Type	Class	Description
static class	AbstractResourceService.Client

Uses of ClientRepresentation in org.keycloak.services.resources.admin

Methods in org.keycloak.services.resources.admin that return ClientRepresentation

Modifier and Type	Method	Description
ClientRepresentation	RealmAdminResource.convertClientDescription(String description)	Base path for importing clients under this realm.
ClientRepresentation	ClientResource.getClient()	Get representation of the client
ClientRepresentation	ClientResource.regenerateRegistrationAccessToken()	Generate a new registration access token for the client

Methods in org.keycloak.services.resources.admin that return types with arguments of type ClientRepresentation

Modifier and Type	Method	Description
Stream<ClientRepresentation>	ClientsResource.getClients(String clientId, boolean viewableOnly, boolean search, String searchQuery, Integer firstResult, Integer maxResults)	Get clients belonging to the realm.

Methods in org.keycloak.services.resources.admin with parameters of type ClientRepresentation

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	ClientsResource.createClient(ClientRepresentation rep)	Create a new client Client's client_id must be unique!
jakarta.ws.rs.core.Response	ClientResource.update(ClientRepresentation rep)	Update the client

Uses of ClientRepresentation in org.keycloak.services.util

Methods in org.keycloak.services.util with parameters of type ClientRepresentation

Modifier and Type	Method	Description
static void	CertificateInfoHelper.updateClientRepresentationCertificateInfo(ClientRepresentation client, CertificateRepresentation rep, String attributePrefix)