API Based Systems
API based systems provide shared connection and authorization details for external service integrations.
REST
Includes settings required for connecting with an http server for standard REST API calls.
url
Base URL for REST endpoint
http://localhost:8080/api
-
contentType
Media content type for REST communications ("query" for url parameters, "none" for no content)
application/xml
application/json
trust
Whether endpoint should be trusted without SSL validation
true
false
auth.method
Method to use for authentication to endpoint (input, basic, bearer, oauth2, oauth1, jwt, custom)
basic
-
auth.token.header
Header to include generated token in
custom-auth
Authorization
auth.prefix
Prefix to include for generated token
none (for no prefix)
Bearer (Basic for basic auth)
header.[header]
Additional header to send in system communications
special-header=value
-
clientPrefix
Client library specific prefix to use for setting client properties
jersey.config.client
-
client.[property]
Client library specific property to include
async.threadPoolSize=10
-
alternateUrls
Comma separated list of alternate URLs for fallback
http://back1.example.com,http://back2.example.com
-
retries
Maximum number of retries allowed in case of server failure
5
0
backoffMs
Milliseconds to wait between retries
500
1000
failTTLMs
Milliseconds to wait until reconsidering a base or alternate URL
10000
5000
responseCookies
Json path to return cookie details received in response (in {path, value, domain, expiry, [name]} format)
cookies
-
responseHeaders
Json path to return header details received in response (in {[name]:[]} format)
headers
-
connector
Rest conector to use (default for multi part body support, apache for native PATCH calls without method header override)
apache
default
Based on auth.method, additional system parameters are used:
Input Authentication Method
Authentication with a request body element:
auth.key
Key to include in each request body for authentication
cmVhbGx5Pw==
-
auth.element
Json path to include authentication key in body
user.apiKey
-
Basic Authentication Method
Username / password based basic authentication:
auth.username
Username to include in each request
admin
-
auth.password
Password to include in each request
pass
-
Bearer Authentication Method
Authentication with a bearer token:
auth.token
Token to include in each request
cmVhbGx5Pw==
-
auth.prefix
Bearer prefix to use in each request
Special_Token
Bearer
OAuth2 Authentication Method
OAuth2 based token authentication:
auth.prefix
Bearer prefix to use for access token in each request
Special_Token
Bearer
auth.provider.authentication
Client authentication model (if required, none, basic or input)
input
basic
auth.provider.key
Key to use for client authentication
somekey
-
auth.provider.secret
Secret to use for client authentication
somesecret
-
auth.provider.url
Url of OAuth provider
http://example.com/oauth
-
auth.provider.refreshUrl
Url for getting new tokens when useRefresh is true
http://example.com/oauth/refresh
[auth.provider.url]
auth.provider.mapping
JMESPath pattern for converting response from provider url to standard OAuth
{"access_token": data.accessToken}
-
auth.token.grant
Grant type (password, clientCredentials, refreshToken, custom)
password
-
auth.token.scope
Authentication scope to apply
customer.read
-
auth.token.useRefresh
Whether the refresh_token received from OAuth endpoint should be used for getting new access tokens
true
false
auth.token.service
Class name for OAuth provider service if custom class is needed
com.github.scribejava.core.builder.api.DefaultApi20
-
Depending on the grant type parameter, additional settings are applicable as follows:
Password Grant Type
auth.username
Username for scribe grant
admin
-
auth.password
Password for scribe grant
pass
-
Refresh Token Grant Type
auth.refreshToken
Refresh token for scripe
-
-
Custom Grant Type
auth.provider.system
Name of runner system to use for token requests
custom_auth
-
provider.custom.url
Url endpoint on custom system to call for access tokens
/GetToken
-
provider.custom.method
Http method to use for access token calls
GET
-
provider.custom.content
Content type for access token calls
query
-
provider.custom.input
Json string to use as call body/parameters for access tokens
{ username: "user", password: ${{rierinoKV.secret}} }
-
provider.custom.refreshUrl
Url endpoint on custom system to call for refreshing tokens
/RefreshToken
-
provider.custom.refreshMethod
Http method to use for token refresh calls
GET
-
provider.custom.refreshContent
Content type for token refresh calls
query
-
provider.custom.refreshInput
Json string to use as call body/parameters for token refresh
-
-
provider.custom.refreshPath
Json path to add refresh token received from access token call to call body/parameters
refresh_token
-
JWT Authentication Method
Authentication generating JWT token wiith a private key:
auth.prefix
Bearer prefix to use in each request
Special_Token
Bearer
auth.ephemeral
Whether each request should generate a new access token
true
false
auth.issuer
Issuer of the token
rierino
-
auth.subject
Subject of the token
12345
-
auth.audience
Target audience for the token
-
auth.payload
Payload of the token
foo
-
auth.id
Id of the token
12345
-
auth.ttl
TTL of token in seconds
36000
3600
auth.claim.*
Claims of the token
user=123
-
auth.header.*
Header of the token
typ=JWT
-
auth.privateKey
Private key for signing token
AAAAAAAA
-
auth.algorithm
Algorithm for signing token
RS256
RS256
In addition to parameters, it is possible to send token inputs (e.g. issuer, ttl, claim, header) using input authentication payload.
Last updated