Package io.quarkus.oidc

Class OidcTenantConfig.Roles

java.lang.Object

io.quarkus.oidc.OidcTenantConfig.Roles

All Implemented Interfaces:

OidcTenantConfig.Roles

Enclosing class:

OidcTenantConfig

@Deprecated(since="3.18")
public static class OidcTenantConfig.Roles
extends Object
implements OidcTenantConfig.Roles

Deprecated.

use the OidcTenantConfigBuilder.RolesBuilder builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OidcTenantConfig.Roles.Source	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
Optional<List<String>>	roleClaimPath	Deprecated. A list of paths to claims containing an array of groups.
Optional<String>	roleClaimSeparator	Deprecated. The separator for splitting strings that contain multiple group values.
Optional<OidcTenantConfig.Roles.Source>	source	Deprecated. Source of the principal roles.

Constructor Summary

Constructors

Constructor	Description
Roles()	Deprecated.

Method Summary

Modifier and Type	Method	Description
static OidcTenantConfig.Roles	fromClaimPath(List<String> path)	Deprecated.
static OidcTenantConfig.Roles	fromClaimPathAndSeparator(List<String> path, String sep)	Deprecated.
Optional<List<String>>	getRoleClaimPath()	Deprecated.
Optional<String>	getRoleClaimSeparator()	Deprecated.
Optional<OidcTenantConfig.Roles.Source>	getSource()	Deprecated.
Optional<List<String>>	roleClaimPath()	Deprecated. A list of paths to claims containing an array of groups.
Optional<String>	roleClaimSeparator()	Deprecated. The separator for splitting strings that contain multiple group values.
void	setRoleClaimPath(List<String> roleClaimPath)	Deprecated.
void	setRoleClaimSeparator(String roleClaimSeparator)	Deprecated.
void	setSource(OidcTenantConfig.Roles.Source source)	Deprecated.
Optional<OidcTenantConfig.Roles.Source>	source()	Deprecated. Source of the principal roles.

Methods inherited from class java.lang.Object

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

Field Details

roleClaimPath

public Optional<List<String>> roleClaimPath

Deprecated.

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

public Optional<String> roleClaimSeparator

Deprecated.

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

public Optional<OidcTenantConfig.Roles.Source> source

Deprecated.

Source of the principal roles.

Constructor Details

Roles

public Roles()

Deprecated.

Method Details

fromClaimPath

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

Deprecated.

fromClaimPathAndSeparator

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

Deprecated.

getRoleClaimPath

public Optional<List<String>> getRoleClaimPath()

Deprecated.

setRoleClaimPath

public void setRoleClaimPath(List<String> roleClaimPath)

Deprecated.

getRoleClaimSeparator

public Optional<String> getRoleClaimSeparator()

Deprecated.

setRoleClaimSeparator

public void setRoleClaimSeparator(String roleClaimSeparator)

Deprecated.

getSource

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

Deprecated.

setSource

public void setSource(OidcTenantConfig.Roles.Source source)

Deprecated.

roleClaimPath

public Optional<List<String>> roleClaimPath()

Deprecated.

Description copied from interface: OidcTenantConfig.Roles

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.

Specified by:

roleClaimPath in interface OidcTenantConfig.Roles

roleClaimSeparator

public Optional<String> roleClaimSeparator()

Deprecated.

Description copied from interface: OidcTenantConfig.Roles

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.

Specified by:

roleClaimSeparator in interface OidcTenantConfig.Roles

source

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

Deprecated.

Description copied from interface: OidcTenantConfig.Roles

Source of the principal roles.

Specified by:

source in interface OidcTenantConfig.Roles