io.gravitee.am.common.oidc.Parameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-am-common Show documentation
There is a newer version: 4.6.0-alpha.2
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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
 *
 *         http://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.gravitee.am.common.oidc;

import java.util.Arrays;
import java.util.Collection;

/**
 * OIDC Parameters
 *
 * See OAuth Parameters
 *
 * @author Titouan COMPIEGNE (titouan.compiegne at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface Parameters {

    /**
     * String value used to associate a Client session with an ID Token, and to mitigate replay attacks.
     */
    String NONCE = "nonce";
    /**
     * ASCII string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.
     */
    String DISPLAY = "display";
    /**
     * Space delimited, case sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for reauthentication and consent.
     */
    String PROMPT = "prompt";
    /**
     * Maximum Authentication Age. Specifies the allowable elapsed time in seconds since the last time the End-User was actively authenticated by the OP.
     */
    String MAX_AGE = "max_age";
    /**
     * 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.
     */
    String UI_LOCALES = "ui_locales";
    /**
     * End-User's preferred languages and scripts for Claims being returned, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference.
     */
    String CLAIMS_LOCALES = "claims_locales";
    /**
     * ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client.
     */
    String ID_TOKEN_HINT = "id_token_hint";
    /**
     * Hint to the Authorization Server about the login identifier the End-User might use to log in (if necessary).
     */
    String LOGIN_HINT = "login_hint";
    /**
     * Requested Authentication Context Class Reference values.
     */
    String ACR_VALUES = "acr_values";
    /**
     * This parameter is used to request that specific Claims be returned.
     */
    String CLAIMS = "claims";
    /**
     * This parameter is used by the Client to provide information about itself to a Self-Issued OP that would normally be provided to an OP during Dynamic Client Registration.
     */
    String REGISTRATION = "registration";
    /**
     * This parameter enables OpenID Connect requests to be passed in a single, self-contained parameter and to be optionally signed and/or encrypted.
     */
    String REQUEST = "request";
    /**
     * This parameter enables OpenID Connect requests to be passed by reference, rather than by value.
     */
    String REQUEST_URI = "request_uri";
    /**
     * This parameter enables OpenID Connect response to be passed in a single, self-contained parameter and to be optionally signed and/or encrypted.
     */
    String RESPONSE = "response";
    /**
     * URL to which the RP is requesting that the End-User's User Agent be redirected after a logout has been performed.
     */
    String POST_LOGOUT_REDIRECT_URI = "post_logout_redirect_uri";

    Collection values = Arrays.asList(NONCE, DISPLAY, PROMPT, MAX_AGE, UI_LOCALES, CLAIMS_LOCALES, ID_TOKEN_HINT, LOGIN_HINT, ACR_VALUES, CLAIMS,
                REGISTRATION, REQUEST, REQUEST_URI);
}