Package io.quarkus.vertx.http.runtime

Class AuthRuntimeConfig

java.lang.Object
io.quarkus.vertx.http.runtime.AuthRuntimeConfig
public class AuthRuntimeConfig extends Object
Authentication mechanism information used for configuring HTTP auth instance for the deployment.

  • Field Details

    • permissions

      @ConfigItem(name="permission") public Map<String,PolicyMappingConfig> permissions
      The HTTP permissions

    • rolePolicy

      @ConfigItem(name="policy") public Map<String,PolicyConfig> rolePolicy
      The HTTP role based policies

    • rolesMapping

      @ConfigItem @ConfigDocMapKey("role-name") public Map<String,List<String>> rolesMapping
      Map the `SecurityIdentity` roles to deployment specific roles and add the matching roles to `SecurityIdentity`.

      For example, if `SecurityIdentity` has a `user` role and the endpoint is secured with a 'UserRole' role, use this property to map the `user` role to the `UserRole` role, and have `SecurityIdentity` to have both `user` and `UserRole` roles.

    • certificateRoleProperties

      @ConfigItem public Optional<Path> certificateRoleProperties
      Properties file containing the client certificate common name (CN) to role mappings. Use it only if the mTLS authentication mechanism is enabled with either `quarkus.http.ssl.client-auth=required` or `quarkus.http.ssl.client-auth=request`.

      Properties file is expected to have the `CN=role1,role,...,roleN` format and should be encoded using UTF-8.

    • realm

      @ConfigItem public Optional<String> realm
      The authentication realm

    • form

      @ConfigItem public FormAuthRuntimeConfig form
      Form Auth config

  • Constructor Details

    • AuthRuntimeConfig

      public AuthRuntimeConfig()