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 JWT token claim to be used in the mapping
UsernamePrefix	getPrefix()
String	getPrefixPolicy()	prefixPolicy specifies how a prefix should apply.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setClaim(String claim)	claim is a JWT token claim to be used in the mapping
void	setPrefix(UsernamePrefix prefix)
void	setPrefixPolicy(String prefixPolicy)	prefixPolicy specifies how a prefix should apply.
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 JWT token claim to be used in the mapping

setClaim

public void setClaim(String claim)

claim is a JWT token claim to be used in the mapping

getPrefix

public UsernamePrefix getPrefix()

setPrefix

public void setPrefix(UsernamePrefix prefix)

getPrefixPolicy

public String getPrefixPolicy()

prefixPolicy specifies how a prefix should apply.

By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins.

Set to "NoPrefix" to disable prefixing.

Example:

(1) `prefix` is set to "myoidc:" and `claim` is set to "username".

If the JWT claim `username` contains value `userA`, the resulting

mapped value will be "myoidc:userA".

(2) `prefix` is set to "myoidc:" and `claim` is set to "email". If the

JWT `email` claim contains value "userA@myoidc.tld", the resulting

mapped value will be "myoidc:userA@myoidc.tld".

(3) `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:

(a) "username": the mapped value will be "https://myoidc.tld#userA"

(b) "email": the mapped value will be "userA@myoidc.tld"

setPrefixPolicy

public void setPrefixPolicy(String prefixPolicy)

prefixPolicy specifies how a prefix should apply.

By default, claims other than `email` will be prefixed with the issuer URL to prevent naming clashes with other plugins.

Set to "NoPrefix" to disable prefixing.

Example:

(1) `prefix` is set to "myoidc:" and `claim` is set to "username".

If the JWT claim `username` contains value `userA`, the resulting

mapped value will be "myoidc:userA".

(2) `prefix` is set to "myoidc:" and `claim` is set to "email". If the

JWT `email` claim contains value "userA@myoidc.tld", the resulting

mapped value will be "myoidc:userA@myoidc.tld".

(3) `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:

(a) "username": the mapped value will be "https://myoidc.tld#userA"

(b) "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)