| Package | Description |
|---|---|
| io.helidon.security.providers.oidc.common |
Open ID Connect (OIDC) classes usable from all OIDC related components.
|
| Modifier and Type | Method and Description |
|---|---|
OidcConfig.Builder |
OidcConfig.Builder.audience(String audience)
Audience of issued tokens.
|
OidcConfig.Builder |
OidcConfig.Builder.authorizationEndpointUri(URI uri)
URI of an authorization endpoint used to redirect users to for logging-in.
|
OidcConfig.Builder |
OidcConfig.Builder.baseScopes(String scopes)
Configure base scopes.
|
static OidcConfig.Builder |
OidcConfig.builder()
Create a builder to programmatically construct OIDC configuration.
|
OidcConfig.Builder |
OidcConfig.Builder.clientId(String clientId)
Client ID as generated by OIDC server.
|
OidcConfig.Builder |
OidcConfig.Builder.clientSecret(String clientSecret)
Client secret as generated by OIDC server.
|
OidcConfig.Builder |
OidcConfig.Builder.config(Config config)
Update this builder with values from configuration.
|
OidcConfig.Builder |
OidcConfig.Builder.cookieName(String cookieName)
Name of the cookie to use.
|
OidcConfig.Builder |
OidcConfig.Builder.frontendUri(String uri)
Full URI of this application that is visible from user browser.
|
OidcConfig.Builder |
OidcConfig.Builder.headerTokenHandler(TokenHandler tokenHandler)
A
TokenHandler to
process header containing a JWT. |
OidcConfig.Builder |
OidcConfig.Builder.identityUri(URI uri)
URI of the identity server, base used to retrieve OIDC metadata.
|
OidcConfig.Builder |
OidcConfig.Builder.introspectEndpointUri(URI uri)
Endpoint to use to validate JWT.
|
OidcConfig.Builder |
OidcConfig.Builder.issuer(String issuer)
Issuer of issued tokens.
|
OidcConfig.Builder |
OidcConfig.Builder.oidcMetadata(Resource resource)
Resource configuration for OIDC Metadata
containing endpoints to various identity services, as well as information about the identity server.
|
OidcConfig.Builder |
OidcConfig.Builder.oidcMetadata(JsonObject metadata)
JsonObject with the OIDC Metadata.
|
OidcConfig.Builder |
OidcConfig.Builder.oidcMetadataWellKnown(Boolean useWellKnown)
If set to true, metadata will be loaded from default (well known)
location, unless it is explicitly defined using oidc-metadata-resource.
|
OidcConfig.Builder |
OidcConfig.Builder.paramName(String paramName)
Name of a query parameter that contains the JWT token when parameter is used.
|
OidcConfig.Builder |
OidcConfig.Builder.proxyHost(String proxyHost)
Proxy host to use.
|
OidcConfig.Builder |
OidcConfig.Builder.proxyPort(int proxyPort)
Proxy port.
|
OidcConfig.Builder |
OidcConfig.Builder.realm(String realm)
Realm to return when not redirecting and an error occurs that sends back WWW-Authenticate header.
|
OidcConfig.Builder |
OidcConfig.Builder.redirect(boolean redirect)
By default the client should redirect to the identity server for the user to log in.
|
OidcConfig.Builder |
OidcConfig.Builder.redirectUri(String redirectUri)
URI to register web server component on, used by the OIDC server to
redirect authorization requests to after a user logs in or approves
scopes.
|
OidcConfig.Builder |
OidcConfig.Builder.scopeAudience(String audience)
Audience of the scope required by this application.
|
OidcConfig.Builder |
OidcConfig.Builder.signJwk(Resource resource)
A resource pointing to JWK with public keys of signing certificates used
to validate JWT.
|
OidcConfig.Builder |
OidcConfig.Builder.signJwk(JwkKeys jwk)
Set
JwkKeys to use for JWT validation. |
OidcConfig.Builder |
OidcConfig.Builder.tokenEndpointUri(URI uri)
URI of a token endpoint used to obtain a JWT based on the authentication
code.
|
OidcConfig.Builder |
OidcConfig.Builder.useCookie(Boolean useCookie)
Whether to use cookie to store JWT between requests.
|
OidcConfig.Builder |
OidcConfig.Builder.useHeader(Boolean useHeader)
Whether to expect JWT in a header field.
|
OidcConfig.Builder |
OidcConfig.Builder.useParam(Boolean useParam)
Whether to use a query parameter to send JWT token from application to this
server.
|
OidcConfig.Builder |
OidcConfig.Builder.validateJwtWithJwk(Boolean useJwk)
Use JWK (a set of keys to validate signatures of JWT) to validate tokens.
|
Copyright © 2018, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.