Package io.fabric8.openshift.api.model.config.v1

Class OIDCClientConfig

java.lang.Object

io.fabric8.openshift.api.model.config.v1.OIDCClientConfig

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<OIDCClientConfigBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class OIDCClientConfig
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<OIDCClientConfigBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

OIDCClientConfig configures how platform clients interact with identity providers as an authentication method

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OIDCClientConfig()	No args constructor for use in serialization
OIDCClientConfig(String clientID, SecretNameReference clientSecret, String componentName, String componentNamespace, List<String> extraScopes)

Method Summary

Modifier and Type	Method	Description
OIDCClientConfigBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getClientID()	clientID is a required field that configures the client identifier, from the identity provider, that the platform component uses for authentication requests made to the identity provider.
SecretNameReference	getClientSecret()	OIDCClientConfig configures how platform clients interact with identity providers as an authentication method
String	getComponentName()	componentName is a required field that specifies the name of the platform component being configured to use the identity provider as an authentication mode.
String	getComponentNamespace()	componentNamespace is a required field that specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running.
List<String>	getExtraScopes()	extraScopes is an optional field that configures the extra scopes that should be requested by the platform component when making authentication requests to the identity provider.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setClientID(String clientID)	clientID is a required field that configures the client identifier, from the identity provider, that the platform component uses for authentication requests made to the identity provider.
void	setClientSecret(SecretNameReference clientSecret)	OIDCClientConfig configures how platform clients interact with identity providers as an authentication method
void	setComponentName(String componentName)	componentName is a required field that specifies the name of the platform component being configured to use the identity provider as an authentication mode.
void	setComponentNamespace(String componentNamespace)	componentNamespace is a required field that specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running.
void	setExtraScopes(List<String> extraScopes)	extraScopes is an optional field that configures the extra scopes that should be requested by the platform component when making authentication requests to the identity provider.
OIDCClientConfigBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OIDCClientConfig

public OIDCClientConfig()

No args constructor for use in serialization

OIDCClientConfig

public OIDCClientConfig(String clientID,
                        SecretNameReference clientSecret,
                        String componentName,
                        String componentNamespace,
                        List<String> extraScopes)

Method Detail

getClientID

public String getClientID()

clientID is a required field that configures the client identifier, from the identity provider, that the platform component uses for authentication requests made to the identity provider. The identity provider must accept this identifier for platform components to be able to use the identity provider as an authentication mode.

clientID must not be an empty string ("").

setClientID

public void setClientID(String clientID)

clientID is a required field that configures the client identifier, from the identity provider, that the platform component uses for authentication requests made to the identity provider. The identity provider must accept this identifier for platform components to be able to use the identity provider as an authentication mode.

clientID must not be an empty string ("").

getClientSecret

public SecretNameReference getClientSecret()

OIDCClientConfig configures how platform clients interact with identity providers as an authentication method

setClientSecret

public void setClientSecret(SecretNameReference clientSecret)

OIDCClientConfig configures how platform clients interact with identity providers as an authentication method

getComponentName

public String getComponentName()

componentName is a required field that specifies the name of the platform component being configured to use the identity provider as an authentication mode. It is used in combination with componentNamespace as a unique identifier.

componentName must not be an empty string ("") and must not exceed 256 characters in length.

setComponentName

public void setComponentName(String componentName)

componentName is a required field that specifies the name of the platform component being configured to use the identity provider as an authentication mode. It is used in combination with componentNamespace as a unique identifier.

componentName must not be an empty string ("") and must not exceed 256 characters in length.

getComponentNamespace

public String getComponentNamespace()

componentNamespace is a required field that specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running. It is used in combination with componentName as a unique identifier.

componentNamespace must not be an empty string ("") and must not exceed 63 characters in length.

setComponentNamespace

public void setComponentNamespace(String componentNamespace)

componentNamespace is a required field that specifies the namespace in which the platform component being configured to use the identity provider as an authentication mode is running. It is used in combination with componentName as a unique identifier.

componentNamespace must not be an empty string ("") and must not exceed 63 characters in length.

getExtraScopes

public List<String> getExtraScopes()

extraScopes is an optional field that configures the extra scopes that should be requested by the platform component when making authentication requests to the identity provider. This is useful if you have configured claim mappings that requires specific scopes to be requested beyond the standard OIDC scopes.

When omitted, no additional scopes are requested.

setExtraScopes

public void setExtraScopes(List<String> extraScopes)

extraScopes is an optional field that configures the extra scopes that should be requested by the platform component when making authentication requests to the identity provider. This is useful if you have configured claim mappings that requires specific scopes to be requested beyond the standard OIDC scopes.

When omitted, no additional scopes are requested.

edit

public OIDCClientConfigBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<OIDCClientConfigBuilder>

toBuilder

public OIDCClientConfigBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)