Package org.springframework.security.oauth2.core.endpoint

Class OAuth2ParameterNames

java.lang.Object
org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames
public final class OAuth2ParameterNames extends Object
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:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ACCESS_TOKEN
    access_token - used in Authorization Response and Access Token Response.
    static final String
    ACTOR_TOKEN
    actor_token - used in Token Exchange Access Token Request.
    static final String
    ACTOR_TOKEN_TYPE
    actor_token_type - used in Token Exchange Access Token Request.
    static final String
    ASSERTION
    assertion - used in Access Token Request.
    static final String
    AUDIENCE
    audience - used in Token Exchange Access Token Request.
    static final String
    CLIENT_ASSERTION
    client_assertion - used in Access Token Request.
    static final String
    CLIENT_ASSERTION_TYPE
    client_assertion_type - used in Access Token Request.
    static final String
    CLIENT_ID
    client_id - used in Authorization Request and Access Token Request.
    static final String
    CLIENT_SECRET
    client_secret - used in Access Token Request.
    static final String
    CODE
    code - used in Authorization Response and Access Token Request.
    static final String
    DEVICE_CODE
    device_code - used in Device Authorization Response and Device Access Token Request.
    static final String
    ERROR
    error - used in Authorization Response and Access Token Response.
    static final String
    ERROR_DESCRIPTION
    error_description - used in Authorization Response and Access Token Response.
    static final String
    ERROR_URI
    error_uri - used in Authorization Response and Access Token Response.
    static final String
    EXPIRES_IN
    expires_in - used in Authorization Response and Access Token Response.
    static final String
    GRANT_TYPE
    grant_type - used in Access Token Request.
    static final String
    INTERVAL
    interval - used in Device Authorization Response.
    static final String
    ISSUED_TOKEN_TYPE
    issued_token_type - used in Token Exchange Access Token Response.
    static final String
    PASSWORD
    password - used in Access Token Request.
    static final String
    REDIRECT_URI
    redirect_uri - used in Authorization Request and Access Token Request.
    static final String
    REFRESH_TOKEN
    refresh_token - used in Access Token Request and Access Token Response.
    static final String
    REGISTRATION_ID
    Non-standard parameter (used internally).
    static final String
    REQUEST_URI
    request_uri - used in Pushed Authorization Response and Authorization Request.
    static final String
    REQUESTED_TOKEN_TYPE
    requested_token_type - used in Token Exchange Access Token Request.
    static final String
    RESOURCE
    resource - used in Token Exchange Access Token Request.
    static final String
    RESPONSE_TYPE
    response_type - used in Authorization Request.
    static final String
    SCOPE
    scope - used in Authorization Request, Authorization Response, Access Token Request and Access Token Response.
    static final String
    STATE
    state - used in Authorization Request and Authorization Response.
    static final String
    SUBJECT_TOKEN
    subject_token - used in Token Exchange Access Token Request.
    static final String
    SUBJECT_TOKEN_TYPE
    subject_token_type - used in Token Exchange Access Token Request.
    static final String
    TOKEN
    token - used in Token Revocation Request.
    static final String
    TOKEN_TYPE
    token_type - used in Authorization Response and Access Token Response.
    static final String
    TOKEN_TYPE_HINT
    token_type_hint - used in Token Revocation Request.
    static final String
    USER_CODE
    user_code - used in Device Authorization Response.
    static final String
    USERNAME
    username - used in Access Token Request.
    static final String
    VERIFICATION_URI
    verification_uri - used in Device Authorization Response.
    static final String
    VERIFICATION_URI_COMPLETE
    verification_uri_complete - used in Device Authorization Response.

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • GRANT_TYPE

      public static final String GRANT_TYPE
      grant_type - used in Access Token Request.
      See Also:

    • RESPONSE_TYPE

      public static final String RESPONSE_TYPE
      response_type - used in Authorization Request.
      See Also:

    • CLIENT_ID

      public static final String CLIENT_ID
      client_id - used in Authorization Request and Access Token Request.
      See Also:

    • CLIENT_SECRET

      public static final String CLIENT_SECRET
      client_secret - used in Access Token Request.
      See Also:

    • CLIENT_ASSERTION_TYPE

      public static final String CLIENT_ASSERTION_TYPE
      client_assertion_type - used in Access Token Request.
      Since:
      5.5
      See Also:

    • CLIENT_ASSERTION

      public static final String CLIENT_ASSERTION
      client_assertion - used in Access Token Request.
      Since:
      5.5
      See Also:

    • ASSERTION

      public static final String ASSERTION
      assertion - used in Access Token Request.
      Since:
      5.5
      See Also:

    • REDIRECT_URI

      public static final String REDIRECT_URI
      redirect_uri - used in Authorization Request and Access Token Request.
      See Also:

    • SCOPE

      public static final String SCOPE
      scope - used in Authorization Request, Authorization Response, Access Token Request and Access Token Response.
      See Also:

    • STATE

      public static final String STATE
      state - used in Authorization Request and Authorization Response.
      See Also:

    • CODE

      public static final String CODE
      code - used in Authorization Response and Access Token Request.
      See Also:

    • ACCESS_TOKEN

      public static final String ACCESS_TOKEN
      access_token - used in Authorization Response and Access Token Response.
      See Also:

    • TOKEN_TYPE

      public static final String TOKEN_TYPE
      token_type - used in Authorization Response and Access Token Response.
      See Also:

    • EXPIRES_IN

      public static final String EXPIRES_IN
      expires_in - used in Authorization Response and Access Token Response.
      See Also:

    • REFRESH_TOKEN

      public static final String REFRESH_TOKEN
      refresh_token - used in Access Token Request and Access Token Response.
      See Also:

    • USERNAME

      public static final String USERNAME
      username - used in Access Token Request.
      See Also:

    • PASSWORD

      public static final String PASSWORD
      password - used in Access Token Request.
      See Also:

    • ERROR

      public static final String ERROR
      error - used in Authorization Response and Access Token Response.
      See Also:

    • ERROR_DESCRIPTION

      public static final String ERROR_DESCRIPTION
      error_description - used in Authorization Response and Access Token Response.
      See Also:

    • ERROR_URI

      public static final String ERROR_URI
      error_uri - used in Authorization Response and Access Token Response.
      See Also:

    • REGISTRATION_ID

      public static final String REGISTRATION_ID
      Non-standard parameter (used internally).
      See Also:

    • TOKEN

      public static final String TOKEN
      token - used in Token Revocation Request.
      Since:
      5.5
      See Also:

    • TOKEN_TYPE_HINT

      public static final String TOKEN_TYPE_HINT
      token_type_hint - used in Token Revocation Request.
      Since:
      5.5
      See Also:

    • DEVICE_CODE

      public static final String DEVICE_CODE
      device_code - used in Device Authorization Response and Device Access Token Request.
      Since:
      6.1
      See Also:

    • USER_CODE

      public static final String USER_CODE
      user_code - used in Device Authorization Response.
      Since:
      6.1
      See Also:

    • VERIFICATION_URI

      public static final String VERIFICATION_URI
      verification_uri - used in Device Authorization Response.
      Since:
      6.1
      See Also:

    • VERIFICATION_URI_COMPLETE

      public static final String VERIFICATION_URI_COMPLETE
      verification_uri_complete - used in Device Authorization Response.
      Since:
      6.1
      See Also:

    • INTERVAL

      public static final String INTERVAL
      interval - used in Device Authorization Response.
      Since:
      6.1
      See Also:

    • AUDIENCE

      public static final String AUDIENCE
      audience - used in Token Exchange Access Token Request.
      Since:
      6.3
      See Also:

    • RESOURCE

      public static final String RESOURCE
      resource - used in Token Exchange Access Token Request.
      Since:
      6.3
      See Also:

    • REQUESTED_TOKEN_TYPE

      public static final String REQUESTED_TOKEN_TYPE
      requested_token_type - used in Token Exchange Access Token Request.
      Since:
      6.3
      See Also:

    • ISSUED_TOKEN_TYPE

      public static final String ISSUED_TOKEN_TYPE
      issued_token_type - used in Token Exchange Access Token Response.
      Since:
      6.3
      See Also:

    • SUBJECT_TOKEN

      public static final String SUBJECT_TOKEN
      subject_token - used in Token Exchange Access Token Request.
      Since:
      6.3
      See Also:

    • SUBJECT_TOKEN_TYPE

      public static final String SUBJECT_TOKEN_TYPE
      subject_token_type - used in Token Exchange Access Token Request.
      Since:
      6.3
      See Also:

    • ACTOR_TOKEN

      public static final String ACTOR_TOKEN
      actor_token - used in Token Exchange Access Token Request.
      Since:
      6.3
      See Also:

    • ACTOR_TOKEN_TYPE

      public static final String ACTOR_TOKEN_TYPE
      actor_token_type - used in Token Exchange Access Token Request.
      Since:
      6.3
      See Also:

    • REQUEST_URI

      public static final String REQUEST_URI
      request_uri - used in Pushed Authorization Response and Authorization Request.
      Since:
      6.5
      See Also: