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", forRemoval=true) public static class OidcTenantConfig.Roles extends Object implements OidcTenantConfig.Roles
Deprecated, for removal: This API element is subject to removal in a future version.
use the OidcTenantConfigBuilder.RolesBuilder builder

  • Field Details

    • roleClaimPath

      public Optional<List<String>> roleClaimPath
      Deprecated, for removal: This API element is subject to removal in a future version.
      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, for removal: This API element is subject to removal in a future version.
      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, for removal: This API element is subject to removal in a future version.
      Source of the principal roles.

  • Constructor Details

    • Roles

      public Roles()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • fromClaimPath

      public static OidcTenantConfig.Roles fromClaimPath(List<String> path)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • fromClaimPathAndSeparator

      public static OidcTenantConfig.Roles fromClaimPathAndSeparator(List<String> path, String sep)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRoleClaimPath

      public Optional<List<String>> getRoleClaimPath()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setRoleClaimPath

      public void setRoleClaimPath(List<String> roleClaimPath)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRoleClaimSeparator

      public Optional<String> getRoleClaimSeparator()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setRoleClaimSeparator

      public void setRoleClaimSeparator(String roleClaimSeparator)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSource

      public Optional<OidcTenantConfig.Roles.Source> getSource()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setSource

      public void setSource(OidcTenantConfig.Roles.Source source)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • roleClaimPath

      public Optional<List<String>> roleClaimPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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, for removal: This API element is subject to removal in a future version.
      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, for removal: This API element is subject to removal in a future version.
      Description copied from interface: OidcTenantConfig.Roles
      Source of the principal roles.
      Specified by:
      source in interface OidcTenantConfig.Roles