io.micronaut.security.oauth2.configuration.endpoints.AuthorizationEndpointConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-security-oauth2 Show documentation

Official Security Solution for Micronaut

There is a newer version: 4.11.1

Show newest version

/*
 * Copyright 2017-2023 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.security.oauth2.configuration.endpoints;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.security.oauth2.endpoint.authorization.request.Display;
import io.micronaut.security.oauth2.endpoint.authorization.request.Prompt;
import io.micronaut.security.oauth2.endpoint.authorization.request.ResponseType;
import java.util.List;
import java.util.Optional;

/**
 * OAuth 2.0 authorization endpoint configuration.
 *
 * @author James Kleeh
 * @since 1.2.0
 */
public interface AuthorizationEndpointConfiguration extends OauthAuthorizationEndpointConfiguration {

    /**
     *
     * @return Mechanism to be used for returning Authorization Response parameters from the Authorization Endpoint.
     */
    Optional getResponseMode();

    /**
     *
     * @return Value that determines the authorization processing flow to be used
     */
    @NonNull
    ResponseType getResponseType();

    /**
     *
     * @return ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.
     */
    Optional getDisplay();

    /**
     *
     * @return Space delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
     */
    Optional getPrompt();

    /**
     *
     * @return Maximum Authentication Age.
     */
    Optional getMaxAge();

    /**
     *
     * @return End-User's preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference.
     */
    Optional> getUiLocales();

    /**
     *
     * @return Requested Authentication Context Class Reference values.
     */
    Optional> getAcrValues();
}