Package io.quarkus.vertx.http.runtime

Class AuthConfig

java.lang.Object

io.quarkus.vertx.http.runtime.AuthConfig

public class AuthConfig
extends Object

Authentication mechanism and SecurityRealm name information used for configuring HTTP auth instance for the deployment.

Field Summary

Fields

Modifier and Type	Field	Description
Optional<Boolean>	basic	If basic auth should be enabled.
FormAuthConfig	form	Form Auth config
Map<String,PolicyMappingConfig>	permissions	The HTTP permissions
boolean	proactive	If this is true and credentials are present then a user will always be authenticated before the request progresses.
Optional<String>	realm	The authentication realm
Map<String,PolicyConfig>	rolePolicy	The HTTP role based policies

Constructor Summary

Constructors

Constructor	Description
AuthConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

basic

@ConfigItem
public Optional<Boolean> basic

If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. If no authentication mechanisms are configured basic auth is the default.

form

@ConfigItem
public FormAuthConfig form

Form Auth config

realm

@ConfigItem
public Optional<String> realm

The authentication realm

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

proactive

@ConfigItem(defaultValue="true")
public boolean proactive

If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason.

Constructor Detail

AuthConfig

public AuthConfig()