fish.payara.security.annotations

Annotation Type OAuth2AuthenticationDefinition

@Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
public @interface OAuth2AuthenticationDefinition

This annotation is used for defining an OAuth2 authentication mechanism

Since:

4.1.2.182

Author:

jonathan coustick

Field Summary

Fields

Modifier and Type	Fields and Description
static String	OAUTH2_MP_AUTH_ENDPOINT The Microprofile Config key for the auth endpoint is "payara.security.oauth2.authEndpoint"
static String	OAUTH2_MP_CLIENT_ID The Microprofile Config key for the clientId is "payara.security.oauth2.clientId"
static String	OAUTH2_MP_CLIENT_SECRET The Microprofile Config key for the client secret is "payara.security.oauth2.clientSecret"
static String	OAUTH2_MP_REDIRECT_URI The Microprofile Config key for the redirect URI is "payara.security.oauth2.redirectURI"
static String	OAUTH2_MP_SCOPE The Microprofile Config key for the scope is "payara.security.oauth2.scope"
static String	OAUTH2_MP_TOKEN_ENDPOINT The Microprofile Config key for the token Endpoint is "payara.security.oauth2.tokenEndpoint"

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	authEndpoint Required.
String	clientId Required.
String	clientSecret Required.
String	tokenEndpoint Required.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	extraParameters An array of extra options that will be sent to the OAuth provider.
String	redirectURI The callback URI.
String	scope The scope that will be requested from the OAuth provider

Field Detail

OAUTH2_MP_AUTH_ENDPOINT

public static final String OAUTH2_MP_AUTH_ENDPOINT

The Microprofile Config key for the auth endpoint is "payara.security.oauth2.authEndpoint"

OAUTH2_MP_TOKEN_ENDPOINT

public static final String OAUTH2_MP_TOKEN_ENDPOINT

The Microprofile Config key for the token Endpoint is "payara.security.oauth2.tokenEndpoint"

OAUTH2_MP_CLIENT_ID

public static final String OAUTH2_MP_CLIENT_ID

The Microprofile Config key for the clientId is "payara.security.oauth2.clientId"

OAUTH2_MP_CLIENT_SECRET

public static final String OAUTH2_MP_CLIENT_SECRET

The Microprofile Config key for the client secret is "payara.security.oauth2.clientSecret"

OAUTH2_MP_REDIRECT_URI

public static final String OAUTH2_MP_REDIRECT_URI

The Microprofile Config key for the redirect URI is "payara.security.oauth2.redirectURI"

OAUTH2_MP_SCOPE

public static final String OAUTH2_MP_SCOPE

The Microprofile Config key for the scope is "payara.security.oauth2.scope"

Element Detail

authEndpoint

public abstract String authEndpoint

Required. The URL for the OAuth2 provider to provide authentication

This must be a https endpoint.

To set this using Microprofile Config use payara.security.oauth2.authEndpoint.

Returns:

tokenEndpoint

public abstract String tokenEndpoint

Required. The URL for the OAuth2 provider to give the authorisation token

To set this using Microprofile Config use payara.security.oauth2.tokenEndpoint

Returns:

clientId

public abstract String clientId

Required. The client identifier issued when the application was registered

To set this using Microprofile Config use payara.security.oauth2.cliendId

Returns:

the client identifier

clientSecret

public abstract String clientSecret

Required. The client secret

It is recommended to set this using an alias.

To set this using Microprofile Config use payara.security.oauth2.clientSecret

Returns:

See Also:

Payara Password Aliases Documentation

redirectURI

public abstract String redirectURI

The callback URI.

If supplied this must be equal to one set in the OAuth2 Authentication provider.

To set this using Microprofile Config use payara.security.oauth2.redirectURI

Returns:

Default:

""

scope

public abstract String scope

The scope that will be requested from the OAuth provider

Returns:

Default:

""

extraParameters

public abstract String[] extraParameters

An array of extra options that will be sent to the OAuth provider.

These must be in the form of "key=value" i.e. extraParameters={"key1=value", "key2=value2"}

Returns:

Default:

{}