CustomApiBuilder
Methods Summary
| Type | Name | Summary |
|---|---|---|
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 Details
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
Sample
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
Sample
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
Sample
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
Sample
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
Sample
Last updated