Package io.quarkus.oidc

Class OidcTenantConfig.Roles

java.lang.Object

io.quarkus.oidc.OidcTenantConfig.Roles

Enclosing class:

OidcTenantConfig

public static class OidcTenantConfig.Roles
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OidcTenantConfig.Roles.Source

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	roleClaimPath	Path to the claim containing an array of groups.
Optional<String>	roleClaimSeparator	Separator for splitting a string which may contain multiple group values.
Optional<OidcTenantConfig.Roles.Source>	source	Source of the principal roles.

Constructor Summary

Constructors

Constructor	Description
Roles()

Method Summary

Modifier and Type	Method	Description
static OidcTenantConfig.Roles	fromClaimPath(String path)
static OidcTenantConfig.Roles	fromClaimPathAndSeparator(String path, String sep)
Optional<String>	getRoleClaimPath()
Optional<String>	getRoleClaimSeparator()
Optional<OidcTenantConfig.Roles.Source>	getSource()
void	setRoleClaimPath(String roleClaimPath)
void	setRoleClaimSeparator(String roleClaimSeparator)
void	setSource(OidcTenantConfig.Roles.Source source)

Methods inherited from class java.lang.Object

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

Field Detail

roleClaimPath

@ConfigItem
public Optional<String> roleClaimPath

Path to the claim containing an array of groups. It starts from the top level JWT JSON object and can contain multiple segments where each segment represents a JSON object name only, example: "realm/groups". Use double quotes with the namespace qualified claim names. This property can be used if a token has no 'groups' claim but has the groups set in a different claim.

roleClaimSeparator

@ConfigItem
public Optional<String> roleClaimSeparator

Separator for splitting a string which may contain multiple group values. It will only be used if the "role-claim-path" property points to a custom claim whose value is a string. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence.

source

@ConfigItem
public Optional<OidcTenantConfig.Roles.Source> source

Source of the principal roles.

Constructor Detail

Roles

public Roles()

Method Detail

fromClaimPath

public static OidcTenantConfig.Roles fromClaimPath(String path)

fromClaimPathAndSeparator

public static OidcTenantConfig.Roles fromClaimPathAndSeparator(String path,
                                                               String sep)

getRoleClaimPath

public Optional<String> getRoleClaimPath()

setRoleClaimPath

public void setRoleClaimPath(String roleClaimPath)

getRoleClaimSeparator

public Optional<String> getRoleClaimSeparator()

setRoleClaimSeparator

public void setRoleClaimSeparator(String roleClaimSeparator)

getSource

public Optional<OidcTenantConfig.Roles.Source> getSource()

setSource

public void setSource(OidcTenantConfig.Roles.Source source)