Servoy 2020 Documentation
Child pages
  • CustomApiBuilder
Skip to end of metadata
Go to start of metadata

Refresh page Apr 15, 2024 13:43

Supported Clients
NGClient

Methods Summary
CustomApiBuilder withAccessTokenExtractor(accessTokenExtractor) Configures the api with a token extractor which parses the concrete type of token from the response string.
CustomApiBuilder withAccessTokenMethod(tokenRequestMethod) The request method used for the access token endpoint (defaults to POST).
CustomApiBuilder withClientAuthentication(clientAuthentication) Configures the api with a client authentication method which specifies how the client credentials are sent.
CustomApiBuilder withRefreshTokenEndpoint(refreshTokenEndpoint) Configure the api with the URL that receives the refresh token requests.
CustomApiBuilder withRevokeTokenEndpoint(revokeTokenEndpoint) 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

Supported Clients

NGClient

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

Supported Clients

NGClient

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

Supported Clients

NGClient

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

Supported Clients

NGClient

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

Supported Clients

NGClient

Sample

  • No labels