Module io.helidon.security.providers.oidc.common
Package io.helidon.security.providers.oidc.common

Interface TenantConfig

  • All Known Implementing Classes:
    OidcConfig
    public interface TenantConfig
    Tenant configuration.

    • Method Detail

      • clientId

        String clientId()
        Client id of this client.
        Returns:
        client id
        See Also:
        BaseBuilder.clientId(String)

      • name

        String name()
        Name of the tenant.
        Returns:
        tenant name

      • baseScopes

        String baseScopes()
        Base scopes to require from OIDC server.
        Returns:
        base scopes
        See Also:
        BaseBuilder.baseScopes(String)

      • validateJwtWithJwk

        boolean validateJwtWithJwk()
        Whether to validate JWT with JWK information (e.g. verify signatures locally).
        Returns:
        if we should validate JWT with JWK
        See Also:
        BaseBuilder.validateJwtWithJwk(Boolean)

      • tenantIntrospectUri

        Optional<URI> tenantIntrospectUri()
        Introspection endpoint URI. Empty if no introspection endpoint has been provided via configuration.
        Returns:
        introspection endpoint URI
        See Also:
        BaseBuilder.introspectEndpointUri(java.net.URI)

      • tenantIssuer

        Optional<String> tenantIssuer()
        Return provided token issuer. Empty if no issuer has been provided via configuration.
        Returns:
        token issuer
        See Also:
        BaseBuilder.issuer(String)

      • tenantSignJwk

        Optional<JwkKeys> tenantSignJwk()
        JWK used for signature validation. Empty if no jwk has been provided via configuration.
        Returns:
        set of keys used to verify tokens
        See Also:
        BaseBuilder.signJwk(JwkKeys)

      • tenantLogoutEndpointUri

        Optional<URI> tenantLogoutEndpointUri()
        Logout endpoint on OIDC server. Empty if no logout endpoint uri has been provided via configuration.
        Returns:
        URI of the logout endpoint
        See Also:
        BaseBuilder.logoutEndpointUri(java.net.URI)

      • tenantTokenEndpointUri

        Optional<URI> tenantTokenEndpointUri()
        Token endpoint URI. Empty if no token endpoint uri has been provided via configuration.
        Returns:
        endpoint URI
        See Also:
        BaseBuilder.tokenEndpointUri(java.net.URI)

      • audience

        String audience()
        Expected token audience.
        Returns:
        audience
        See Also:
        BaseBuilder.audience(String)

      • scopeAudience

        String scopeAudience()
        Audience URI of custom scopes.
        Returns:
        scope audience
        See Also:
        BaseBuilder.scopeAudience(String)

      • identityUri

        URI identityUri()
        Identity server URI.
        Returns:
        identity server URI
        See Also:
        BaseBuilder.identityUri(URI)

      • realm

        String realm()
        Realm to use for WWW-Authenticate response (if needed).
        Returns:
        realm name

      • tokenEndpointAuthentication

        OidcConfig.ClientAuthentication tokenEndpointAuthentication()
        Type of authentication mechanism used for token endpoint.
        Returns:
        client authentication type

      • clientTimeout

        Duration clientTimeout()
        Expected timeout of HTTP client operations.
        Returns:
        client timeout

      • authorizationEndpoint

        Optional<URI> authorizationEndpoint()
        Authorization endpoint.
        Returns:
        authorization endpoint uri as a string
        See Also:
        BaseBuilder.authorizationEndpointUri(URI)

      • clientSecret

        String clientSecret()
        Client secret.
        Returns:
        configured client secret
        See Also:
        BaseBuilder.clientSecret(String)

      • serverType

        String serverType()
        Server type.
        Returns:
        configured server type
        See Also:
        BaseBuilder.serverType(String)

      • oidcMetadata

        JsonObject oidcMetadata()
        OIDC metadata.
        Returns:
        configured oidc metadata
        See Also:
        BaseBuilder.oidcMetadata(JsonObject)

      • useWellKnown

        boolean useWellKnown()
        Whether to use OIDC well known metadata.
        Returns:
        configured oidc metadata
        See Also:
        BaseBuilder.oidcMetadataWellKnown(boolean)