Top Description Methods
jakarta.security.enterprise.authentication.mechanism.http.openid

public @Interface OpenIdProviderMetadata

extends Annotation
Annotations
@Retention:RUNTIME
Imports
java.lang.annotation.Retention

OpenIdProviderMetadata annotation overrides the openid connect provider's endpoint value, discovered using providerUri.
Authors
Gaurav Gupta, Rudy De Busscher

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

URL for the OAuth2 provider.
authorizationEndpoint
()

Required.

public String

Returns:

URL for logging out of server session.
endSessionEndpoint
()

Optional.

public String
public String
issuer()

Required.

public String

Returns:

URL pointing to the JWK Set.
jwksURI
()

Required.

public String
public String
public String

Returns:

URL for the OAuth2 provider.
tokenEndpoint
()

Required.

public String

Returns:

URL for User Info.
userinfoEndpoint
()

Required.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

authorizationEndpointback to summary
public String authorizationEndpoint()

Required. The URL for the OAuth2 provider to provide authentication. This must be a https endpoint.

Returns:String

URL for the OAuth2 provider.

endSessionEndpointback to summary
public 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.

Returns:String

URL for logging out of server session.

idTokenSigningAlgorithmsSupportedback to summary
public String idTokenSigningAlgorithmsSupported()

Required. The supported Signing algorithms for the ID token by provider.

issuerback to summary
public String issuer()

Required. The issuer of the tokens issued by the Provider.

jwksURIback to summary
public 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.

Returns:String

URL pointing to the JWK Set.

responseTypeSupportedback to summary
public String responseTypeSupported()

Required. The supported response types by the Provider.

subjectTypeSupportedback to summary
public String subjectTypeSupported()

Required. The supported subject Types by the Provider.

tokenEndpointback to summary
public String tokenEndpoint()

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

Returns:String

URL for the OAuth2 provider.

userinfoEndpointback to summary
public String userinfoEndpoint()

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

Returns:String

URL for User Info.