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 enum	OidcTenantConfig.Roles.Source

Field Summary

Fields

Modifier and Type	Field	Description
Optional<List<String>>	roleClaimPath	A list of paths to claims containing an array of groups.
Optional<String>	roleClaimSeparator	The separator for splitting strings that 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(List<String> path)
static OidcTenantConfig.Roles	fromClaimPathAndSeparator(List<String> path, String sep)
Optional<List<String>>	getRoleClaimPath()
Optional<String>	getRoleClaimSeparator()
Optional<OidcTenantConfig.Roles.Source>	getSource()
void	setRoleClaimPath(List<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 Details

roleClaimPath

@ConfigItem
public Optional<List<String>> roleClaimPath

A list of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments. Each segment represents a JSON object name only; for 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 one or more different claims.

roleClaimSeparator

@ConfigItem
public Optional<String> roleClaimSeparator

The separator for splitting strings that contain multiple group values. It is only used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space is used by default because the standard `scope` claim can contain a space-separated sequence.

source

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

Source of the principal roles.

Constructor Details

Roles

public Roles()

Method Details

fromClaimPath

public static OidcTenantConfig.Roles fromClaimPath(List<String> path)

fromClaimPathAndSeparator

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

getRoleClaimPath

public Optional<List<String>> getRoleClaimPath()

setRoleClaimPath

public void setRoleClaimPath(List<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)