Show TOC

OAuth 2.0 Methods for Extensions in Class of Service Provider Type BAdILocate this document in the navigation structure

You have created a new class for your new service provider type. It has inherited methods that contain the default settings that are specific to the OAuth 2.0 service provider.

OAuth 2.0 Service Provider Settings

The following methods have been inherited from the superclass CL_OA2C_SPECIFICS_ABSTRACT. To change or include parameters that are specific to your service provider, redefine the relevant methods.

The methods that are available cover the following areas:

  • Parameter names for access token requests (authorization code flow)
  • Parameter names for access token requests (SAML 2.0 bearer assertion)
  • Parameter names for refresh requests
  • Parameter names for revocation requests
  • Paths for endpoint settings
  • Separator of the OAuth 2.0 scopes
  • Additional parameters
Table 1: Service Provider OAuth 2.0 Settings
Method Description Use
IF_OA2C_SPECIFICS~GET_AC_AT_REQU_PARAM_NAMES Auth. Code: 3. Get Access Token REQUEST Param. Names This method contains parameter names for access token requests in the authorization code grant type, for example, client ID, client secret, and redirection URI.
IF_OA2C_SPECIFICS~GET_AC_AT_RESP_PARAM_NAMES Auth. Code: 4. Get Access Token RESPONSE Param. Names Enter the required parameter names for access token responses from the service provider in the authorization code grant type, for example, the token type name, or exception names.
IF_OA2C_SPECIFICS~GET_AC_AUTH_REQU_PARAM_NAMES Auth. Code: 1. Get Authorization REQUEST Param. Names This method contains the parameter names for authorization code requests in the authorization code grant type, for example, client ID, redirection URI, and OAuth 2.0 scope.
IF_OA2C_SPECIFICS~GET_AC_AUTH_RESP_PARAM_NAMES Auth. Code: 2. Get Authorization RESPONSE Param. Names Enter the required parameter names for an authorization code response from the service provider in the authorization code grant type, for example, exception names.
IF_OA2C_SPECIFICS~GET_SAML20_AT_REQU_PARAM_NAMES SAML 2.0: 1. Get Access Token REQUEST Param. Names This method contains the parameter names for access token requests in the SAML 2.0 bearer assertion grant type, for example, client ID, client secret, and redirection URI.
IF_OA2C_SPECIFICS~GET_SAML20_AT_RESP_PARAM_NAMES SAML 2.0: 2. Get Access Token RESPONSE Param. Names Enter the required parameter names for an access token response from the service provider in the SAML 2.0 bearer assertion grant type, for example, the token type name or exception names.
IF_OA2C_SPECIFICS~GET_REFRESH_REQU_PARAM_NAMES Refresh: 1. Get Refresh REQUEST Param. Names This method contains the parameter names for refresh requests, for example, client ID, client secret, and redirection URI.
IF_OA2C_SPECIFICS~GET_REFRESH_RESP_PARAM_NAMES Refresh: 2. Get Refresh RESPONSE Param. Names Enter the required parameter names for a refresh response from the service provider, for example, exception names.
IF_OA2C_SPECIFICS~GET_REVOKE_REQU_PARAM_NAMES Revocation: 1. Get Revocation REQUEST Param. Names This method contains the parameter names for revocation requests, for example, client ID, client secret, and redirection URI.
IF_OA2C_SPECIFICS~GET_REVOKE_RESP_PARAM_NAMES Revocation: 2. Get Revocation RESPONSE Param. Names Enter the required parameter names for a revocation response from the service provider, for example, exceptions.
IF_OA2C_SPECIFICS~GET_ENDPOINT_SETTINGS Endpoint settings: Changeability & Paths Enter the appropriate code and replace the paths of the authorization endpoint, the token endpoint, and/or the revocation endpoint according to the requirements of your service provider. Using the IF_CHANGEABLE parameter, you determine whether or not the endpoint settings can be changed.
Note

Enter the endpoint URIs without the scheme https://.

IF_OA2C_SPECIFICS~GET_SCOPE_SEPARATOR Scope separator If your service provider uses a different OAuth 2.0 scope separator such as Facebook, which requires a comma (,) separator, redefine this method.
IF_OA2C_SPECIFICS~GET_SUPPORTED_GRANT_TYPES Get OAuth 2.0 flows supported by this Service Provider (SP) Identify whether you want to allow the grant types authorization code, SAML 2.0 bearer assertion, refresh, and revocation.
IF_OA2C_SPECIFICS~GET_SUPPORTED_CLIENT_AUTH Get supported client authentication methods Here you determine whether the service provider supports OAuth 2.0 client authentication using HTTP basic authentication and/or form fields.
IF_OA2C_SPECIFICS~GET_RESOURCE_ACCESS_PROPERTIES Protected Resource Access Properties Here you define the supported methods for how OAuth 2.0 access tokens can be sent to the resource server of this particular service provider.
IF_OA2C_SPECIFICS~GET_CONFIG_EXTENSION Configuration Extension Here you define the filter value of your BAdI implementation for the configuration extension.
IF_OA2C_SPECIFICS~GET_ADD_PARAMS Additional Parameters Here you define the names of additional parameters sent with the grant types.
IF_OA2C_SPECIFICS~GET_SAML20_NO_B64URL_ENCODING SAML 2.0 Assertion: Use Base64 encoding instead of Base64url If this parameter is set to <TRUE>, the system uses the Base64 instead of base64url encoding for SAML 2.0 bearer assertions.