CustomApiBuilder
Overview
The CustomApiBuilder facilitates the configuration of the OAuth plugin for integration with less common or custom providers, including in-house solutions. This includes options for parsing and handling tokens, specifying request methods, and configuring authentication and endpoint URLs for token-related operations such as access, refresh, and revocation.
It supports methods to customize the API by enabling access token extraction, specifying token request methods, defining client authentication mechanisms, and setting up refresh and revoke token endpoints, allowing integration with a variety of OAuth implementations.
Methods Summarized
Configures the api with a token extractor which parses the concrete type of token from the response string.
The request method used for the access token endpoint (defaults to POST).
Configures the api with a client authentication method which specifies how the client credentials are sent.
Configure the api with the URL that receives the refresh token requests.
Configure the api with the URL that receives the revoke token requests.
Methods Detailed
withAccessTokenExtractor(accessTokenExtractor)
Configures the api with a token extractor which parses the concrete type of token from the response string.
Parameters
String accessTokenExtractor see plugins.oauth.OAuthTokenExtractors
Returns: CustomApiBuilder the api builder for method chaining
withAccessTokenMethod(tokenRequestMethod)
The request method used for the access token endpoint (defaults to POST).
Parameters
String tokenRequestMethod can be 'post' or 'get'
Returns: CustomApiBuilder the api builder for method chaining
withClientAuthentication(clientAuthentication)
Configures the api with a client authentication method which specifies how the client credentials are sent. They can be sent as basic Auth header or in the request body.
Parameters
String clientAuthentication see plugins.oauth.ClientAuthentication
Returns: CustomApiBuilder the api builder for method chaining
withRefreshTokenEndpoint(refreshTokenEndpoint)
Configure the api with the URL that receives the refresh token requests.
Parameters
String refreshTokenEndpoint ;
Returns: CustomApiBuilder the api builder for method chaining
withRevokeTokenEndpoint(revokeTokenEndpoint)
Configure the api with the URL that receives the revoke token requests.
Parameters
String revokeTokenEndpoint ;
Returns: CustomApiBuilder the api builder for method chaining
Last updated