org.eclipse.microprofile.auth

Annotation Type LoginConfig

@Inherited
 @Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface LoginConfig

A security annotation describing the authentication method, and the associated realm name that should be used for this application.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	authMethod Soften the requirements here: The authMethod is used to configure the authentication mechanism for the JAX-RS application.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	realmName The realm name element specifies the realm name to use in HTTP Basic authorization.

Element Detail

authMethod

public abstract String authMethod

Soften the requirements here: The authMethod is used to configure the authentication mechanism for the JAX-RS application. As a prerequisite to gaining access to any web resources which are protected by an authorization constraint, a user must have authenticated using the configured mechanism. Supported values include "BASIC", "DIGEST", "FORM", "CLIENT-CERT", "MP-JWT", or a vendor-specific authentication scheme. Note the the MP-JWT TCK currently only validates that a deployment with MP-JWT authentication follows the specification, but in the future, we MAY look to combine the use of MP-JWT tokens with other authentication mechanisms.

Returns:

the configured auth-method

realmName

public abstract String realmName

The realm name element specifies the realm name to use in HTTP Basic authorization.

Returns:

Default:

""