ClientRepresentation (Red Hat Single Sign-On 7.0.0.GA public API)

java.lang.Object
- org.keycloak.representations.idm.ClientRepresentation

Direct Known Subclasses:

ApplicationRepresentation
```
public class ClientRepresentation
extends Object
```
Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`adminUrl`
`protected Map<String,String>`	`attributes`
`protected String`	`baseUrl`
`protected Boolean`	`bearerOnly`
`protected String`	`clientAuthenticatorType`
`protected String`	`clientId`
`protected String`	`clientTemplate`
`protected Boolean`	`consentRequired`
`protected String[]`	`defaultRoles`
`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 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`
`protected List<String>`	`webOrigins`

Constructor Summary

Constructors
Constructor and Description

ClientRepresentation()

Constructors
Constructor and Description
`ClientRepresentation()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAdminUrl()`
`Map<String,String>`	`getAttributes()`
`String`	`getBaseUrl()`
`String`	`getClientAuthenticatorType()`
`String`	`getClientId()`
`String`	`getClientTemplate()`
`String[]`	`getDefaultRoles()`
`String`	`getDescription()`
`String`	`getId()`
`String`	`getName()`
`Integer`	`getNodeReRegistrationTimeout()`
`Integer`	`getNotBefore()`
`String`	`getProtocol()`
`List<ProtocolMapperRepresentation>`	`getProtocolMappers()`
`List<String>`	`getRedirectUris()`
`Map<String,Integer>`	`getRegisteredNodes()`
`String`	`getRegistrationAccessToken()`
`String`	`getRootUrl()`
`String`	`getSecret()`
`List<String>`	`getWebOrigins()`
`Boolean`	`isBearerOnly()`
`Boolean`	`isConsentRequired()`
`Boolean`	`isDirectAccessGrantsEnabled()`
`Boolean`	`isDirectGrantsOnly()` Deprecated.
`Boolean`	`isEnabled()`
`Boolean`	`isFrontchannelLogout()`
`Boolean`	`isFullScopeAllowed()`
`Boolean`	`isImplicitFlowEnabled()`
`Boolean`	`isPublicClient()`
`Boolean`	`isServiceAccountsEnabled()`
`Boolean`	`isStandardFlowEnabled()`
`Boolean`	`isSurrogateAuthRequired()`
`Boolean`	`isUseTemplateConfig()`
`Boolean`	`isUseTemplateMappers()`
`Boolean`	`isUseTemplateScope()`
`void`	`setAdminUrl(String adminUrl)`
`void`	`setAttributes(Map<String,String> attributes)`
`void`	`setBaseUrl(String baseUrl)`
`void`	`setBearerOnly(Boolean bearerOnly)`
`void`	`setClientAuthenticatorType(String clientAuthenticatorType)`
`void`	`setClientId(String clientId)`
`void`	`setClientTemplate(String clientTemplate)`
`void`	`setConsentRequired(Boolean consentRequired)`
`void`	`setDefaultRoles(String[] defaultRoles)`
`void`	`setDescription(String description)`
`void`	`setDirectAccessGrantsEnabled(Boolean directAccessGrantsEnabled)`
`void`	`setDirectGrantsOnly(Boolean directGrantsOnly)`
`void`	`setEnabled(Boolean enabled)`
`void`	`setFrontchannelLogout(Boolean frontchannelLogout)`
`void`	`setFullScopeAllowed(Boolean fullScopeAllowed)`
`void`	`setId(String id)`
`void`	`setImplicitFlowEnabled(Boolean implicitFlowEnabled)`
`void`	`setName(String name)`
`void`	`setNodeReRegistrationTimeout(Integer nodeReRegistrationTimeout)`
`void`	`setNotBefore(Integer notBefore)`
`void`	`setProtocol(String protocol)`
`void`	`setProtocolMappers(List<ProtocolMapperRepresentation> protocolMappers)`
`void`	`setPublicClient(Boolean publicClient)`
`void`	`setRedirectUris(List<String> redirectUris)`
`void`	`setRegisteredNodes(Map<String,Integer> registeredNodes)`
`void`	`setRegistrationAccessToken(String registrationAccessToken)`
`void`	`setRootUrl(String rootUrl)`
`void`	`setSecret(String secret)`
`void`	`setServiceAccountsEnabled(Boolean serviceAccountsEnabled)`
`void`	`setStandardFlowEnabled(Boolean standardFlowEnabled)`
`void`	`setSurrogateAuthRequired(Boolean surrogateAuthRequired)`
`void`	`setUseTemplateConfig(Boolean useTemplateConfig)`
`void`	`setUseTemplateMappers(Boolean useTemplateMappers)`
`void`	`setUseTemplateScope(Boolean useTemplateScope)`
`void`	`setWebOrigins(List<String> webOrigins)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id
```
protected String id
```

clientId
```
protected String clientId
```

name
```
protected String name
```

description
```
protected String description
```

rootUrl
```
protected String rootUrl
```

adminUrl
```
protected String adminUrl
```

baseUrl
```
protected String baseUrl
```

surrogateAuthRequired

protected Boolean surrogateAuthRequired

enabled
```
protected Boolean enabled
```

clientAuthenticatorType

protected String clientAuthenticatorType

secret
```
protected String secret
```

registrationAccessToken

protected String registrationAccessToken

defaultRoles
```
protected String[] defaultRoles
```

redirectUris
```
protected List<String> redirectUris
```

webOrigins
```
protected List<String> webOrigins
```

notBefore
```
protected Integer notBefore
```

bearerOnly
```
protected Boolean bearerOnly
```

consentRequired
```
protected Boolean consentRequired
```

standardFlowEnabled
```
protected Boolean standardFlowEnabled
```

implicitFlowEnabled
```
protected Boolean implicitFlowEnabled
```

directAccessGrantsEnabled

protected Boolean directAccessGrantsEnabled

serviceAccountsEnabled

protected Boolean serviceAccountsEnabled

directGrantsOnly

@Deprecated
protected Boolean directGrantsOnly

Deprecated.

publicClient
```
protected Boolean publicClient
```

frontchannelLogout
```
protected Boolean frontchannelLogout
```

protocol
```
protected String protocol
```

attributes

protected Map<String,String> attributes

fullScopeAllowed
```
protected Boolean fullScopeAllowed
```

nodeReRegistrationTimeout

protected Integer nodeReRegistrationTimeout

registeredNodes

protected Map<String,Integer> registeredNodes

protocolMappers

protected List<ProtocolMapperRepresentation> protocolMappers

clientTemplate
```
protected String clientTemplate
```

Constructor Detail
- ClientRepresentation
```
public ClientRepresentation()
```

Method Detail

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getClientId
```
public String getClientId()
```

setClientId

public void setClientId(String clientId)

isEnabled
```
public Boolean isEnabled()
```

setEnabled

public void setEnabled(Boolean enabled)

isSurrogateAuthRequired

public Boolean isSurrogateAuthRequired()

setSurrogateAuthRequired

public void setSurrogateAuthRequired(Boolean surrogateAuthRequired)

getRootUrl
```
public String getRootUrl()
```

setRootUrl

public void setRootUrl(String rootUrl)

getAdminUrl
```
public String getAdminUrl()
```

setAdminUrl

public void setAdminUrl(String adminUrl)

getBaseUrl
```
public String getBaseUrl()
```

setBaseUrl

public void setBaseUrl(String baseUrl)

getClientAuthenticatorType

public String getClientAuthenticatorType()

setClientAuthenticatorType

public void setClientAuthenticatorType(String clientAuthenticatorType)

getSecret
```
public String getSecret()
```

setSecret
```
public void setSecret(String secret)
```

getRegistrationAccessToken

public String getRegistrationAccessToken()

setRegistrationAccessToken

public void setRegistrationAccessToken(String registrationAccessToken)

getRedirectUris
```
public List<String> getRedirectUris()
```

setRedirectUris

public void setRedirectUris(List<String> redirectUris)

getWebOrigins
```
public List<String> getWebOrigins()
```

setWebOrigins

public void setWebOrigins(List<String> webOrigins)

getDefaultRoles
```
public String[] getDefaultRoles()
```

setDefaultRoles

public void setDefaultRoles(String[] defaultRoles)

getNotBefore
```
public Integer getNotBefore()
```

setNotBefore

public void setNotBefore(Integer notBefore)

isBearerOnly
```
public Boolean isBearerOnly()
```

setBearerOnly

public void setBearerOnly(Boolean bearerOnly)

isConsentRequired
```
public Boolean isConsentRequired()
```

setConsentRequired

public void setConsentRequired(Boolean consentRequired)

isStandardFlowEnabled

public Boolean isStandardFlowEnabled()

setStandardFlowEnabled

public void setStandardFlowEnabled(Boolean standardFlowEnabled)

isImplicitFlowEnabled

public Boolean isImplicitFlowEnabled()

setImplicitFlowEnabled

public void setImplicitFlowEnabled(Boolean implicitFlowEnabled)

isDirectAccessGrantsEnabled

public Boolean isDirectAccessGrantsEnabled()

setDirectAccessGrantsEnabled

public void setDirectAccessGrantsEnabled(Boolean directAccessGrantsEnabled)

isServiceAccountsEnabled

public Boolean isServiceAccountsEnabled()

setServiceAccountsEnabled

public void setServiceAccountsEnabled(Boolean serviceAccountsEnabled)

isDirectGrantsOnly

@Deprecated
public Boolean isDirectGrantsOnly()

Deprecated.

setDirectGrantsOnly

public void setDirectGrantsOnly(Boolean directGrantsOnly)

isPublicClient
```
public Boolean isPublicClient()
```

setPublicClient

public void setPublicClient(Boolean publicClient)

isFullScopeAllowed
```
public Boolean isFullScopeAllowed()
```

setFullScopeAllowed

public void setFullScopeAllowed(Boolean fullScopeAllowed)

getProtocol
```
public String getProtocol()
```

setProtocol

public void setProtocol(String protocol)

getAttributes

public Map<String,String> getAttributes()

setAttributes

public void setAttributes(Map<String,String> attributes)

getNodeReRegistrationTimeout

public Integer getNodeReRegistrationTimeout()

setNodeReRegistrationTimeout

public void setNodeReRegistrationTimeout(Integer nodeReRegistrationTimeout)

getRegisteredNodes

public Map<String,Integer> getRegisteredNodes()

setRegisteredNodes

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

isFrontchannelLogout
```
public Boolean isFrontchannelLogout()
```

setFrontchannelLogout

public void setFrontchannelLogout(Boolean frontchannelLogout)

getProtocolMappers

public List<ProtocolMapperRepresentation> getProtocolMappers()

setProtocolMappers

public void setProtocolMappers(List<ProtocolMapperRepresentation> protocolMappers)

getClientTemplate
```
public String getClientTemplate()
```

setClientTemplate

public void setClientTemplate(String clientTemplate)

isUseTemplateConfig
```
public Boolean isUseTemplateConfig()
```

setUseTemplateConfig

public void setUseTemplateConfig(Boolean useTemplateConfig)

isUseTemplateScope
```
public Boolean isUseTemplateScope()
```

setUseTemplateScope

public void setUseTemplateScope(Boolean useTemplateScope)

isUseTemplateMappers
```
public Boolean isUseTemplateMappers()
```

setUseTemplateMappers

public void setUseTemplateMappers(Boolean useTemplateMappers)

Class ClientRepresentation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

clientId

name

description

rootUrl

adminUrl

baseUrl

surrogateAuthRequired

enabled

clientAuthenticatorType

secret

registrationAccessToken

defaultRoles

redirectUris

webOrigins

notBefore

bearerOnly

consentRequired

standardFlowEnabled

implicitFlowEnabled

directAccessGrantsEnabled

serviceAccountsEnabled

directGrantsOnly

publicClient

frontchannelLogout

protocol

attributes

fullScopeAllowed

nodeReRegistrationTimeout

registeredNodes

protocolMappers

clientTemplate

Constructor Detail

ClientRepresentation

Method Detail

getId

setId

getName

setName

getDescription

setDescription

getClientId

setClientId

isEnabled

setEnabled

isSurrogateAuthRequired

setSurrogateAuthRequired

getRootUrl

setRootUrl

getAdminUrl

setAdminUrl

getBaseUrl

setBaseUrl

getClientAuthenticatorType

setClientAuthenticatorType

getSecret

setSecret

getRegistrationAccessToken

setRegistrationAccessToken

getRedirectUris

setRedirectUris

getWebOrigins

setWebOrigins

getDefaultRoles

setDefaultRoles

getNotBefore

setNotBefore

isBearerOnly

setBearerOnly

isConsentRequired

setConsentRequired

isStandardFlowEnabled

setStandardFlowEnabled

isImplicitFlowEnabled