Keycloak 24.0.0 · org.keycloak.representations.idm.ClientRepresentation

Modifier and Type	Field and Description
private Map<String, Boolean>	access
protected String	adminUrl
protected Boolean	alwaysDisplayInConsole
protected Map<String, String>	attributes
protected Map<String, String>	authenticationFlowBindingOverrides
protected Boolean	authorizationServicesEnabled
private ResourceServerRepresentation	authorizationSettings
protected String	baseUrl
protected Boolean	bearerOnly
protected String	clientAuthenticatorType
protected String	clientId
protected String	clientTemplate Deprecated
protected Boolean	consentRequired
protected List<String>	defaultClientScopes
protected String[]	defaultRoles Deprecated
protected String	description
protected Boolean	directAccessGrantsEnabled
protected Boolean	directGrantsOnly Deprecated
protected Boolean	enabled
protected Boolean	frontchannelLogout
protected Boolean	fullScopeAllowed
protected String	id
protected Boolean	implicitFlowEnabled
protected String	name
protected Integer	nodeReRegistrationTimeout
protected Integer	notBefore
protected List<String>	optionalClientScopes
protected String	origin
protected String	protocol
protected List<ProtocolMapperRepresentation>	protocolMappers
protected Boolean	publicClient
protected List<String>	redirectUris
protected Map<String, Integer>	registeredNodes
protected String	registrationAccessToken
protected String	rootUrl
protected String	secret
protected Boolean	serviceAccountsEnabled
protected Boolean	standardFlowEnabled
protected Boolean	surrogateAuthRequired
private Boolean	useTemplateConfig Deprecated
private Boolean	useTemplateMappers Deprecated
private Boolean	useTemplateScope Deprecated
protected List<String>	webOrigins

Constructor Summary

Access	Constructor and Description
public	ClientRepresentation()

Method Summary

Modifier and Type	Method and Description
public Map<String, Boolean>	getAccess()
public String	getAdminUrl()
public Map<String, String>	getAttributes()
public Map<String, String>	getAuthenticationFlowBindingOverrides()
public Boolean	getAuthorizationServicesEnabled()
public ResourceServerRepresentation	getAuthorizationSettings()
public String	getBaseUrl()
public String	getClientAuthenticatorType()
public String	getClientId()
public String	getClientTemplate() Deprecated
public List<String>	getDefaultClientScopes()
public String[]	getDefaultRoles() Deprecated
public String	getDescription()
public String	getId()
public String	getName()
public Integer	getNodeReRegistrationTimeout()
public Integer	getNotBefore()
public List<String>	getOptionalClientScopes()
public String	Returns: NULL if user stored locally getOrigin() Returns id of ClientStorageProvider that loaded this user
public String	getProtocol()
public List<ProtocolMapperRepresentation>	getProtocolMappers()
public List<String>	getRedirectUris()
public Map<String, Integer>	getRegisteredNodes()
public String	getRegistrationAccessToken()
public String	getRootUrl()
public String	getSecret()
public List<String>	getWebOrigins()
public Boolean	isAlwaysDisplayInConsole()
public Boolean	isBearerOnly()
public Boolean	isConsentRequired()
public Boolean	isDirectAccessGrantsEnabled()
public Boolean	isDirectGrantsOnly() Deprecated
public Boolean	isEnabled()
public Boolean	isFrontchannelLogout()
public Boolean	isFullScopeAllowed()
public Boolean	isImplicitFlowEnabled()
public Boolean	isPublicClient()
public Boolean	isServiceAccountsEnabled()
public Boolean	isStandardFlowEnabled()
public Boolean	isSurrogateAuthRequired()
public Boolean	isUseTemplateConfig() Deprecated
public Boolean	isUseTemplateMappers() Deprecated
public Boolean	isUseTemplateScope() Deprecated
public void	setAccess(Map<String, Boolean> access)
public void	setAdminUrl(String adminUrl)
public void	setAlwaysDisplayInConsole(Boolean alwaysDisplayInConsole)
public void	setAttributes(Map<String, String> attributes)
public void	setAuthenticationFlowBindingOverrides(Map<String, String> authenticationFlowBindingOverrides)
public void	setAuthorizationServicesEnabled(Boolean authorizationServicesEnabled)
public void	setAuthorizationSettings(ResourceServerRepresentation authorizationSettings)
public void	setBaseUrl(String baseUrl)
public void	setBearerOnly(Boolean bearerOnly)
public void	setClientAuthenticatorType(String clientAuthenticatorType)
public void	setClientId(String clientId)
public void	setConsentRequired(Boolean consentRequired)
public void	setDefaultClientScopes(List<String> defaultClientScopes)
public void	setDefaultRoles(String[] defaultRoles) Deprecated
public void	setDescription(String description)
public void	setDirectAccessGrantsEnabled(Boolean directAccessGrantsEnabled)
public void	setDirectGrantsOnly(Boolean directGrantsOnly)
public void	setEnabled(Boolean enabled)
public void	setFrontchannelLogout(Boolean frontchannelLogout)
public void	setFullScopeAllowed(Boolean fullScopeAllowed)
public void	setId(String id)
public void	setImplicitFlowEnabled(Boolean implicitFlowEnabled)
public void	setName(String name)
public void	setNodeReRegistrationTimeout(Integer nodeReRegistrationTimeout)
public void	setNotBefore(Integer notBefore)
public void	setOptionalClientScopes(List<String> optionalClientScopes)
public void	setOrigin(String origin)
public void	setProtocol(String protocol)
public void	setProtocolMappers(List<ProtocolMapperRepresentation> protocolMappers)
public void	setPublicClient(Boolean publicClient)
public void	setRedirectUris(List<String> redirectUris)
public void	setRegisteredNodes(Map<String, Integer> registeredNodes)
public void	setRegistrationAccessToken(String registrationAccessToken)
public void	setRootUrl(String rootUrl)
public void	setSecret(String secret)
public void	setServiceAccountsEnabled(Boolean serviceAccountsEnabled)
public void	setStandardFlowEnabled(Boolean standardFlowEnabled)
public void	setSurrogateAuthRequired(Boolean surrogateAuthRequired)
public void	setWebOrigins(List<String> webOrigins)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

access	back to summary
private Map<String, Boolean> access

adminUrl	back to summary
protected String adminUrl

alwaysDisplayInConsole	back to summary
protected Boolean alwaysDisplayInConsole

attributes	back to summary
protected Map<String, String> attributes

authenticationFlowBindingOverrides	back to summary
protected Map<String, String> authenticationFlowBindingOverrides

authorizationServicesEnabled	back to summary
protected Boolean authorizationServicesEnabled

authorizationSettings	back to summary
private ResourceServerRepresentation authorizationSettings

baseUrl	back to summary
protected String baseUrl

bearerOnly	back to summary
protected Boolean bearerOnly

clientAuthenticatorType	back to summary
protected String clientAuthenticatorType

clientId	back to summary
protected String clientId

clientTemplate	back to summary
protected String clientTemplate Deprecated Annotations @Deprecated

consentRequired	back to summary
protected Boolean consentRequired

defaultClientScopes	back to summary
protected List<String> defaultClientScopes

defaultRoles	back to summary
protected String[] defaultRoles Deprecated Annotations @Deprecated

description	back to summary
protected String description

directAccessGrantsEnabled	back to summary
protected Boolean directAccessGrantsEnabled

directGrantsOnly	back to summary
protected Boolean directGrantsOnly Deprecated Annotations @Deprecated

enabled	back to summary
protected Boolean enabled

frontchannelLogout	back to summary
protected Boolean frontchannelLogout

fullScopeAllowed	back to summary
protected Boolean fullScopeAllowed

id	back to summary
protected String id

implicitFlowEnabled	back to summary
protected Boolean implicitFlowEnabled

name	back to summary
protected String name

nodeReRegistrationTimeout	back to summary
protected Integer nodeReRegistrationTimeout

notBefore	back to summary
protected Integer notBefore

optionalClientScopes	back to summary
protected List<String> optionalClientScopes

origin	back to summary
protected String origin

protocol	back to summary
protected String protocol

protocolMappers	back to summary
protected List<ProtocolMapperRepresentation> protocolMappers

publicClient	back to summary
protected Boolean publicClient

redirectUris	back to summary
protected List<String> redirectUris

registeredNodes	back to summary
protected Map<String, Integer> registeredNodes

registrationAccessToken	back to summary
protected String registrationAccessToken

rootUrl	back to summary
protected String rootUrl

secret	back to summary
protected String secret

serviceAccountsEnabled	back to summary
protected Boolean serviceAccountsEnabled

standardFlowEnabled	back to summary
protected Boolean standardFlowEnabled

surrogateAuthRequired	back to summary
protected Boolean surrogateAuthRequired

useTemplateConfig	back to summary
private Boolean useTemplateConfig Deprecated Annotations @Deprecated

useTemplateMappers	back to summary
private Boolean useTemplateMappers Deprecated Annotations @Deprecated

useTemplateScope	back to summary
private Boolean useTemplateScope Deprecated Annotations @Deprecated

webOrigins	back to summary
protected List<String> webOrigins

Constructor Detail

ClientRepresentation	back to summary
public ClientRepresentation()

Method Detail

getAccess	back to summary
public Map<String, Boolean> getAccess()

getAdminUrl	back to summary
public String getAdminUrl()

getAttributes	back to summary
public Map<String, String> getAttributes()

getAuthenticationFlowBindingOverrides	back to summary
public Map<String, String> getAuthenticationFlowBindingOverrides()

getAuthorizationServicesEnabled	back to summary
public Boolean getAuthorizationServicesEnabled()

getAuthorizationSettings	back to summary
public ResourceServerRepresentation getAuthorizationSettings()

getBaseUrl	back to summary
public String getBaseUrl()

getClientAuthenticatorType	back to summary
public String getClientAuthenticatorType()

getClientId	back to summary
public String getClientId()

getClientTemplate	back to summary
public String getClientTemplate() Deprecated Annotations @Deprecated

getDefaultClientScopes	back to summary
public List<String> getDefaultClientScopes()

getDefaultRoles	back to summary
public String[] getDefaultRoles() Deprecated Annotations @Deprecated

getDescription	back to summary
public String getDescription()

getId	back to summary
public String getId()

getName	back to summary
public String getName()

getNodeReRegistrationTimeout	back to summary
public Integer getNodeReRegistrationTimeout()

getNotBefore	back to summary
public Integer getNotBefore()

getOptionalClientScopes	back to summary
public List<String> getOptionalClientScopes()

getOrigin

back to summary

public String getOrigin()

Returns id of ClientStorageProvider that loaded this user

Returns:String: NULL if user stored locally

getProtocol	back to summary
public String getProtocol()

getProtocolMappers	back to summary
public List<ProtocolMapperRepresentation> getProtocolMappers()

getRedirectUris	back to summary
public List<String> getRedirectUris()

getRegisteredNodes	back to summary
public Map<String, Integer> getRegisteredNodes()

getRegistrationAccessToken	back to summary
public String getRegistrationAccessToken()

getRootUrl	back to summary
public String getRootUrl()

getSecret	back to summary
public String getSecret()

getWebOrigins	back to summary
public List<String> getWebOrigins()

isAlwaysDisplayInConsole	back to summary
public Boolean isAlwaysDisplayInConsole()

isBearerOnly	back to summary
public Boolean isBearerOnly()

isConsentRequired	back to summary
public Boolean isConsentRequired()

isDirectAccessGrantsEnabled	back to summary
public Boolean isDirectAccessGrantsEnabled()

isDirectGrantsOnly	back to summary
public Boolean isDirectGrantsOnly() Deprecated Annotations @Deprecated

isEnabled	back to summary
public Boolean isEnabled()

isFrontchannelLogout	back to summary
public Boolean isFrontchannelLogout()

isFullScopeAllowed	back to summary
public Boolean isFullScopeAllowed()

isImplicitFlowEnabled	back to summary
public Boolean isImplicitFlowEnabled()

isPublicClient	back to summary
public Boolean isPublicClient()

isServiceAccountsEnabled	back to summary
public Boolean isServiceAccountsEnabled()

isStandardFlowEnabled	back to summary
public Boolean isStandardFlowEnabled()

isSurrogateAuthRequired	back to summary
public Boolean isSurrogateAuthRequired()

isUseTemplateConfig	back to summary
public Boolean isUseTemplateConfig() Deprecated Annotations @Deprecated

isUseTemplateMappers	back to summary
public Boolean isUseTemplateMappers() Deprecated Annotations @Deprecated

isUseTemplateScope	back to summary
public Boolean isUseTemplateScope() Deprecated Annotations @Deprecated

setAccess	back to summary
public void setAccess(Map<String, Boolean> access)

setAdminUrl	back to summary
public void setAdminUrl(String adminUrl)

setAlwaysDisplayInConsole	back to summary
public void setAlwaysDisplayInConsole(Boolean alwaysDisplayInConsole)

setAttributes	back to summary
public void setAttributes(Map<String, String> attributes)

setAuthenticationFlowBindingOverrides	back to summary
public void setAuthenticationFlowBindingOverrides(Map<String, String> authenticationFlowBindingOverrides)

setAuthorizationServicesEnabled	back to summary
public void setAuthorizationServicesEnabled(Boolean authorizationServicesEnabled)

setAuthorizationSettings	back to summary
public void setAuthorizationSettings(ResourceServerRepresentation authorizationSettings)

setBaseUrl	back to summary
public void setBaseUrl(String baseUrl)

setBearerOnly	back to summary
public void setBearerOnly(Boolean bearerOnly)

setClientAuthenticatorType	back to summary
public void setClientAuthenticatorType(String clientAuthenticatorType)

setClientId	back to summary
public void setClientId(String clientId)

setConsentRequired	back to summary
public void setConsentRequired(Boolean consentRequired)

setDefaultClientScopes	back to summary
public void setDefaultClientScopes(List<String> defaultClientScopes)

setDefaultRoles	back to summary
public void setDefaultRoles(String[] defaultRoles) Deprecated Annotations @Deprecated

setDescription	back to summary
public void setDescription(String description)

setDirectAccessGrantsEnabled	back to summary
public void setDirectAccessGrantsEnabled(Boolean directAccessGrantsEnabled)

setDirectGrantsOnly	back to summary
public void setDirectGrantsOnly(Boolean directGrantsOnly)

setEnabled	back to summary
public void setEnabled(Boolean enabled)

setFrontchannelLogout	back to summary
public void setFrontchannelLogout(Boolean frontchannelLogout)

setFullScopeAllowed	back to summary
public void setFullScopeAllowed(Boolean fullScopeAllowed)

setId	back to summary
public void setId(String id)

setImplicitFlowEnabled	back to summary
public void setImplicitFlowEnabled(Boolean implicitFlowEnabled)

setName	back to summary
public void setName(String name)

setNodeReRegistrationTimeout	back to summary
public void setNodeReRegistrationTimeout(Integer nodeReRegistrationTimeout)

setNotBefore	back to summary
public void setNotBefore(Integer notBefore)

setOptionalClientScopes	back to summary
public void setOptionalClientScopes(List<String> optionalClientScopes)

setOrigin	back to summary
public void setOrigin(String origin)

setProtocol	back to summary
public void setProtocol(String protocol)

setProtocolMappers	back to summary
public void setProtocolMappers(List<ProtocolMapperRepresentation> protocolMappers)

setPublicClient	back to summary
public void setPublicClient(Boolean publicClient)

setRedirectUris	back to summary
public void setRedirectUris(List<String> redirectUris)

setRegisteredNodes	back to summary
public void setRegisteredNodes(Map<String, Integer> registeredNodes)

setRegistrationAccessToken	back to summary
public void setRegistrationAccessToken(String registrationAccessToken)

setRootUrl	back to summary
public void setRootUrl(String rootUrl)

setSecret	back to summary
public void setSecret(String secret)

setServiceAccountsEnabled	back to summary
public void setServiceAccountsEnabled(Boolean serviceAccountsEnabled)

setStandardFlowEnabled	back to summary
public void setStandardFlowEnabled(Boolean standardFlowEnabled)

setSurrogateAuthRequired	back to summary
public void setSurrogateAuthRequired(Boolean surrogateAuthRequired)

setWebOrigins	back to summary
public void setWebOrigins(List<String> webOrigins)

public Class ClientRepresentation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail