Interface OAuth2ParameterNames


  • public interface OAuth2ParameterNames
    Standard and custom (non-standard) parameter names defined in the OAuth Parameters Registry and used by the authorization endpoint, token endpoint and token revocation endpoint.
    Since:
    5.0
    See Also:
    11.2 OAuth Parameters Registry
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ACCESS_TOKEN
      access_token - used in Authorization Response and Access Token Response.
      static java.lang.String ASSERTION
      assertion - used in Access Token Request.
      static java.lang.String CLIENT_ASSERTION
      client_assertion - used in Access Token Request.
      static java.lang.String CLIENT_ASSERTION_TYPE
      client_assertion_type - used in Access Token Request.
      static java.lang.String CLIENT_ID
      client_id - used in Authorization Request and Access Token Request.
      static java.lang.String CLIENT_SECRET
      client_secret - used in Access Token Request.
      static java.lang.String CODE
      code - used in Authorization Response and Access Token Request.
      static java.lang.String ERROR
      error - used in Authorization Response and Access Token Response.
      static java.lang.String ERROR_DESCRIPTION
      error_description - used in Authorization Response and Access Token Response.
      static java.lang.String ERROR_URI
      error_uri - used in Authorization Response and Access Token Response.
      static java.lang.String EXPIRES_IN
      expires_in - used in Authorization Response and Access Token Response.
      static java.lang.String GRANT_TYPE
      grant_type - used in Access Token Request.
      static java.lang.String PASSWORD
      password - used in Access Token Request.
      static java.lang.String REDIRECT_URI
      redirect_uri - used in Authorization Request and Access Token Request.
      static java.lang.String REFRESH_TOKEN
      refresh_token - used in Access Token Request and Access Token Response.
      static java.lang.String REGISTRATION_ID
      Non-standard parameter (used internally).
      static java.lang.String RESPONSE_TYPE
      response_type - used in Authorization Request.
      static java.lang.String SCOPE
      scope - used in Authorization Request, Authorization Response, Access Token Request and Access Token Response.
      static java.lang.String STATE
      state - used in Authorization Request and Authorization Response.
      static java.lang.String TOKEN
      token - used in Token Revocation Request.
      static java.lang.String TOKEN_TYPE
      token_type - used in Authorization Response and Access Token Response.
      static java.lang.String TOKEN_TYPE_HINT
      token_type_hint - used in Token Revocation Request.
      static java.lang.String USERNAME
      username - used in Access Token Request.
    • Field Detail

      • GRANT_TYPE

        static final java.lang.String GRANT_TYPE
        grant_type - used in Access Token Request.
        See Also:
        Constant Field Values
      • RESPONSE_TYPE

        static final java.lang.String RESPONSE_TYPE
        response_type - used in Authorization Request.
        See Also:
        Constant Field Values
      • CLIENT_ID

        static final java.lang.String CLIENT_ID
        client_id - used in Authorization Request and Access Token Request.
        See Also:
        Constant Field Values
      • CLIENT_SECRET

        static final java.lang.String CLIENT_SECRET
        client_secret - used in Access Token Request.
        See Also:
        Constant Field Values
      • CLIENT_ASSERTION_TYPE

        static final java.lang.String CLIENT_ASSERTION_TYPE
        client_assertion_type - used in Access Token Request.
        Since:
        5.5
        See Also:
        Constant Field Values
      • CLIENT_ASSERTION

        static final java.lang.String CLIENT_ASSERTION
        client_assertion - used in Access Token Request.
        Since:
        5.5
        See Also:
        Constant Field Values
      • ASSERTION

        static final java.lang.String ASSERTION
        assertion - used in Access Token Request.
        Since:
        5.5
        See Also:
        Constant Field Values
      • REDIRECT_URI

        static final java.lang.String REDIRECT_URI
        redirect_uri - used in Authorization Request and Access Token Request.
        See Also:
        Constant Field Values
      • SCOPE

        static final java.lang.String SCOPE
        scope - used in Authorization Request, Authorization Response, Access Token Request and Access Token Response.
        See Also:
        Constant Field Values
      • STATE

        static final java.lang.String STATE
        state - used in Authorization Request and Authorization Response.
        See Also:
        Constant Field Values
      • CODE

        static final java.lang.String CODE
        code - used in Authorization Response and Access Token Request.
        See Also:
        Constant Field Values
      • ACCESS_TOKEN

        static final java.lang.String ACCESS_TOKEN
        access_token - used in Authorization Response and Access Token Response.
        See Also:
        Constant Field Values
      • TOKEN_TYPE

        static final java.lang.String TOKEN_TYPE
        token_type - used in Authorization Response and Access Token Response.
        See Also:
        Constant Field Values
      • EXPIRES_IN

        static final java.lang.String EXPIRES_IN
        expires_in - used in Authorization Response and Access Token Response.
        See Also:
        Constant Field Values
      • REFRESH_TOKEN

        static final java.lang.String REFRESH_TOKEN
        refresh_token - used in Access Token Request and Access Token Response.
        See Also:
        Constant Field Values
      • USERNAME

        static final java.lang.String USERNAME
        username - used in Access Token Request.
        See Also:
        Constant Field Values
      • PASSWORD

        static final java.lang.String PASSWORD
        password - used in Access Token Request.
        See Also:
        Constant Field Values
      • ERROR

        static final java.lang.String ERROR
        error - used in Authorization Response and Access Token Response.
        See Also:
        Constant Field Values
      • ERROR_DESCRIPTION

        static final java.lang.String ERROR_DESCRIPTION
        error_description - used in Authorization Response and Access Token Response.
        See Also:
        Constant Field Values
      • ERROR_URI

        static final java.lang.String ERROR_URI
        error_uri - used in Authorization Response and Access Token Response.
        See Also:
        Constant Field Values
      • REGISTRATION_ID

        static final java.lang.String REGISTRATION_ID
        Non-standard parameter (used internally).
        See Also:
        Constant Field Values
      • TOKEN

        static final java.lang.String TOKEN
        token - used in Token Revocation Request.
        Since:
        5.5
        See Also:
        Constant Field Values
      • TOKEN_TYPE_HINT

        static final java.lang.String TOKEN_TYPE_HINT
        token_type_hint - used in Token Revocation Request.
        Since:
        5.5
        See Also:
        Constant Field Values