fish.payara.security.annotations

Annotation Type OpenIdProviderMetadata

@Retention(value=RUNTIME)
public @interface OpenIdProviderMetadata

OpenIdProviderMetadata annotation overrides the openid connect provider's endpoint value, discovered using providerUri.

Author:

Gaurav Gupta

Field Summary

Fields

Modifier and Type	Fields and Description
static String	OPENID_MP_AUTHORIZATION_ENDPOINT The Microprofile Config key for the auth endpoint is "payara.security.openid.provider.authorizationEndpoint"
static String	OPENID_MP_END_SESSION_ENDPOINT The Microprofile Config key for the end session Endpoint is "payara.security.openid.provider.endSessionEndpoint"
static String	OPENID_MP_JWKS_URI The Microprofile Config key for the jwks uri is "payara.security.openid.provider.jwksURI"
static String	OPENID_MP_TOKEN_ENDPOINT The Microprofile Config key for the token Endpoint is "payara.security.openid.provider.tokenEndpoint"
static String	OPENID_MP_USERINFO_ENDPOINT The Microprofile Config key for the userinfo Endpoint is "payara.security.openid.provider.userinfoEndpoint"

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	authorizationEndpoint Required.
String	endSessionEndpoint Optional.
String	jwksURI Required.
String	tokenEndpoint Required.
String	userinfoEndpoint Required.

Field Detail

OPENID_MP_AUTHORIZATION_ENDPOINT

public static final String OPENID_MP_AUTHORIZATION_ENDPOINT

The Microprofile Config key for the auth endpoint is "payara.security.openid.provider.authorizationEndpoint"

OPENID_MP_TOKEN_ENDPOINT

public static final String OPENID_MP_TOKEN_ENDPOINT

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

OPENID_MP_USERINFO_ENDPOINT

public static final String OPENID_MP_USERINFO_ENDPOINT

The Microprofile Config key for the userinfo Endpoint is "payara.security.openid.provider.userinfoEndpoint"

OPENID_MP_END_SESSION_ENDPOINT

public static final String OPENID_MP_END_SESSION_ENDPOINT

The Microprofile Config key for the end session Endpoint is "payara.security.openid.provider.endSessionEndpoint"

OPENID_MP_JWKS_URI

public static final String OPENID_MP_JWKS_URI

The Microprofile Config key for the jwks uri is "payara.security.openid.provider.jwksURI"

Element Detail

authorizationEndpoint

public abstract String authorizationEndpoint

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.openid.provider.authorizationEndpoint.

Returns:

Default:

""

tokenEndpoint

public abstract String tokenEndpoint

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

To set this using Microprofile Config use payara.security.openid.provider.tokenEndpoint

Returns:

Default:

""

userinfoEndpoint

public abstract String userinfoEndpoint

Required. An OAuth 2.0 Protected Resource that returns Claims about the authenticated End-User.

To set this using Microprofile Config use payara.security.openid.provider.userinfoEndpoint

Returns:

Default:

""

endSessionEndpoint

public abstract String endSessionEndpoint

Optional. OP endpoint to notify that the End-User has logged out of the site and might want to log out of the OP as well.

To set this using Microprofile Config use payara.security.openid.provider.endSessionEndpoint

Returns:

Default:

""

jwksURI

public abstract String jwksURI

Required. An OpenId Connect Provider's JSON Web Key Set document

This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set may also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server.

To set this using Microprofile Config use payara.security.openid.provider.jwksURI

Returns:

Default:

""