io.quarkus.oidc.runtime

Class OidcConfig.Roles

java.lang.Object

io.quarkus.oidc.runtime.OidcConfig.Roles

Enclosing class:

OidcConfig

public static class OidcConfig.Roles
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Optional<String>	roleClaimPath Path to the claim containing an array of groups.
(package private) Optional<String>	roleClaimSeparator Separator for splitting a string which may contain multiple group values.

Constructor Summary

Constructors

Constructor and Description
Roles()

Method Summary

Modifier and Type	Method and Description
static OidcConfig.Roles	fromClaimPath(String path)
static OidcConfig.Roles	fromClaimPathAndSeparator(String path, String sep)
Optional<String>	getRoleClaimPath()
Optional<String>	getRoleClaimSeparator()

Methods inherited from class java.lang.Object

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

Field Detail

roleClaimPath

@ConfigItem
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". This property can be used if a token has no 'groups' claim but has the groups set in a different claim.

roleClaimSeparator

@ConfigItem
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.

Constructor Detail

Roles

public Roles()

Method Detail

getRoleClaimPath

public Optional<String> getRoleClaimPath()

getRoleClaimSeparator

public Optional<String> getRoleClaimSeparator()

fromClaimPath

public static OidcConfig.Roles fromClaimPath(String path)

fromClaimPathAndSeparator

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