OAuth2 plugin
OAuth2 service

This service provides REST API for OAuth2 support. More info about the REST API at OAuth2 REST API v1.

QorusOAuth2RestApi::OAuth2Rest is the main service class

REST API Classes

Client administration

These are classes which provides REST API for OAuth2 client administration.

QorusOAuth2RestApi::OAuth2AdminRestHandler

  • handler for client administration REST API

QorusOAuth2RestApi::OAuth2ClientsRestClass

  • provides REST API to manage OAuth2 clients (POST, GET)

QorusOAuth2RestApi::Oauth2ClientIdRestClass

  • provides REST API to manage specific OAuth2 client (GET, DELETE)

QorusOAuth2RestApi::OAuth2CodeRestClass

  • provides non public REST API to generate authorization code or access token for
  • this is used in Authorization Grant flow (generates authorization code) and Implicit flow (generates access token directly)
  • called by UI when end user approves access for the OAuth2 client

Token generation

QorusOAuth2RestApi::OAuth2ApiRestHandler

  • handler for token generation REST API

QorusOAuth2RestApi::OAuth2Constants

  • defines constants used in REST API classes

QorusOAuth2RestApi::OAuth2BasicAuthenticator

  • provides Basic type authenticator to authenticate token generation request

QorusOAuth2RestApi::OAuth2RestClass

  • provides GET REST API method for token generation

QorusOAuth2RestApi::AbstractOAuth2Handler

  • abstract handler for token generation

QorusOAuth2RestApi::OAuth2CodeTypeHandler

  • implements Authoriztion Code Grant flow, 1st step - authorization code generation

QorusOAuth2RestApi::OAuth2AuthorizationCodeTypeHandler

  • implements Authoriztion Code Grant flow, 2nd step - exchange the authorization code for access token

QorusOAuth2RestApi::OAuth2ClientCredentialsTypeHandler

  • implements Client Credentials Grant flow

QorusOAuth2RestApi::OAuth2PasswordTypeHandler

  • implements Resource Owner Password Credentials Grant

QorusOAuth2RestApi::OAuth2TokenTypeHandler

  • implements Implicit Grant flow

QorusOAuth2RestApi::OAuth2RefreshTokenTypeHandler

  • implements token refresh

Authentication Token Store Classes

Classes to store tokens used in OAuth2

QorusOAuth2RestApi::QorusAuthToken

QorusOAuth2RestApi::QorusAuthTokenStore