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

Class UsernameClaimMapping

java.lang.Object

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

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UsernameClaimMapping()	No args constructor for use in serialization
UsernameClaimMapping(String claim, UsernamePrefix prefix, String prefixPolicy)

Method Summary

Modifier and Type	Method	Description
UsernameClaimMappingBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getClaim()	claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.
UsernamePrefix	getPrefix()
String	getPrefixPolicy()	prefixPolicy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setClaim(String claim)	claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.
void	setPrefix(UsernamePrefix prefix)
void	setPrefixPolicy(String prefixPolicy)	prefixPolicy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field.
UsernameClaimMappingBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

UsernameClaimMapping

public UsernameClaimMapping()

No args constructor for use in serialization

UsernameClaimMapping

public UsernameClaimMapping(String claim,
                            UsernamePrefix prefix,
                            String prefixPolicy)

Method Detail

getClaim

public String getClaim()

claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.

claim must not be an empty string ("") and must not exceed 256 characters.

setClaim

public void setClaim(String claim)

claim is a required field that configures the JWT token claim whose value is assigned to the cluster identity field associated with this mapping.

claim must not be an empty string ("") and must not exceed 256 characters.

getPrefix

public UsernamePrefix getPrefix()

setPrefix

public void setPrefix(UsernamePrefix prefix)

getPrefixPolicy

public String getPrefixPolicy()

prefixPolicy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field.

Allowed values are 'Prefix', 'NoPrefix', and omitted (not provided or an empty string).

When set to 'Prefix', the value specified in the prefix field will be prepended to the value of the JWT claim. The prefix field must be set when prefixPolicy is 'Prefix'.

When set to 'NoPrefix', no prefix will be prepended to the value of the JWT claim.

When omitted, this means no opinion and the platform is left to choose any prefixes that are applied which is subject to change over time. Currently, the platform prepends `{issuerURL}#` to the value of the JWT claim when the claim is not 'email'. As an example, consider the following scenario:

`prefix` is unset, `issuerURL` is set to `https://myoidc.tld`,

the JWT claims include "username":"userA" and "email":"userA@myoidc.tld",

and `claim` is set to:

- "username": the mapped value will be "https://myoidc.tld#userA"

- "email": the mapped value will be "userA@myoidc.tld"

setPrefixPolicy

public void setPrefixPolicy(String prefixPolicy)

prefixPolicy is an optional field that configures how a prefix should be applied to the value of the JWT claim specified in the 'claim' field.

Allowed values are 'Prefix', 'NoPrefix', and omitted (not provided or an empty string).

When set to 'Prefix', the value specified in the prefix field will be prepended to the value of the JWT claim. The prefix field must be set when prefixPolicy is 'Prefix'.

When set to 'NoPrefix', no prefix will be prepended to the value of the JWT claim.

When omitted, this means no opinion and the platform is left to choose any prefixes that are applied which is subject to change over time. Currently, the platform prepends `{issuerURL}#` to the value of the JWT claim when the claim is not 'email'. As an example, consider the following scenario:

`prefix` is unset, `issuerURL` is set to `https://myoidc.tld`,

the JWT claims include "username":"userA" and "email":"userA@myoidc.tld",

and `claim` is set to:

- "username": the mapped value will be "https://myoidc.tld#userA"

- "email": the mapped value will be "userA@myoidc.tld"

edit

public UsernameClaimMappingBuilder edit()

Specified by:

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

toBuilder

public UsernameClaimMappingBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

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