Syntax:
com.ibi.agents.XDBearerTokenAgent
iIT Service Object:
format: Bearer Token Agent
Description: Create the authorization header with a bearer token.
Parameters:
Parameter |
Description |
---|---|
Token Store Provider * |
Name of the Token Store Provider where tokens will be cached. |
Authorization Header Namespace |
Special register namespace where the Authorization HTTP header will be stored. If not supplied, the default namespace will be used. |
Token Field |
Name of the field that holds the token in the JSON response. |
Expiration Field |
Name of the field in the JSON response that specifies the length of time (in seconds) for which the token is valid. |
Default Expiration Time |
Time in seconds a token can stay in the token store. Applies only to tokens without a specific expiration time. |
Authorization Server |
|
Authorization Server URL * |
URL where a new access token can be retrieved. The URL should be fully specified, including the https scheme. |
HTTP Client Provider * |
HTTP Client Provider (Pooling Provider) that manages HTTP connections for this emitter. |
HTTP Method |
POST sends a URL encoded entity, GET sends the request without a request entity. |
User ID |
User ID for authentication challenges. |
Password |
Password for authentication challenges. |
Request Header Namespace |
Special register namespace from which HTTP headers for the outgoing request will be taken. Choose Default Namespace to send HDR type registers with no namespace prefix, or supply a namespace prefix here. None means that no special registers will be sent as HTTP headers. |
Response Header Namespace |
Special register namespace into which HTTP headers from the incoming response will be saved. Choose Default Namespace to create special registers with no namespace prefix, or supply a namespace prefix here. |
Excluded Headers |
A comma delimited list (case insensitive) of headers that should not be sent with the request, even if found in request header namespace. |
Maximum Response Size |
Maximum size of a response entity that can be received by this emitter. 0 means no maximum and blank will default to 256KB. |
Persistence |
If checked, have the server maintain the connection. |
Response Timeout value in Seconds * |
Number of seconds to wait for a response before signalling an error. |
POST Request |
|
Grant Type |
Specifies the requested response type. Usually client_credentials. |
Client ID |
The Client ID of the caller. |
Client Secret |
The Key registered for the caller. |
Resource |
The App ID URI of the receiving web service. |
Resource Owner Username |
The username to encode in the POST body when grant type is password. |
Resource Owner Password |
The Password to encode in the POST body when grant type is password. |
Special Register Namespace for Additional Request Fields |
If specified, registers in this namespace will be included as fields in body of a POST request. |
Edges:
The following table lists the available Line Edges for the Bearer Token Agent Service (com.ibi.agents.XDBearerTokenAgent).
Line Edges |
Description |
---|---|
OnError |
An exception occurred during execution. |
OnSuccess |
The operation was successful. |
OnFailure |
A fail condition occurred during execution. |
OnParseError |
Could not parse a document. |
OnFailedOperation |
Could not perform the operation requested. |