Configurations


Config

An extension to hook oauth2 to http extension connectors.

Parameters

Name Type Description Default Value Required

Name

String

The name of this configuration. With this name can be later referenced.

x 

Operations

Invalidate Oauth Context

Clears the oauth context for a token manager and a resource owner id.

Parameters

Name Type Description Default Value Required

Token Manager

The token manager which holds the credentials to invalidate.

x 

Resource Owner Id

String

The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

default

 

Retrieve Access Token

Returns the access token of the token manager for the parametrized resource owner ID

Parameters

Name Type Description Default Value Required

Token Manager

The token manager which holds the access token.

x 

Resource Owner Id

String

The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

default

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Output

Enumeration, one of:

  • PAYLOAD

  • MESSAGE

The type of the operation's output that will be stored in the target variable

PAYLOAD

 

Output

Type

String

Retrieve Custom Token Response Param

Returns the value of the parameter that was extracted during the dance from the token manager for the parametrized resource owner ID

Parameters

Name Type Description Default Value Required

Token Manager

The token manager which holds the access token.

x 

Resource Owner Id

String

The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

default

 

Key

String

to look for in the elements that has been extracted after the previous OAuth dance.

x 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Output

Enumeration, one of:

  • PAYLOAD

  • MESSAGE

The type of the operation's output that will be stored in the target variable

PAYLOAD

 

Output

Type

Any

Retrieve Expires In

Returns the expiration of the oauth context for the parametrized resource owner ID

Parameters

Name Type Description Default Value Required

Token Manager

The token manager which holds the access token.

x 

Resource Owner Id

String

The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

default

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Output

Enumeration, one of:

  • PAYLOAD

  • MESSAGE

The type of the operation's output that will be stored in the target variable

PAYLOAD

 

Output

Type

String

Retrieve Refresh Token

Returns the refresh token of the oauth context for the parametrized resource owner ID

Parameters

Name Type Description Default Value Required

Token Manager

The token manager which holds the refresh token.

x 

Resource Owner Id

String

The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

default

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Output

Enumeration, one of:

  • PAYLOAD

  • MESSAGE

The type of the operation's output that will be stored in the target variable

PAYLOAD

 

Output

Type

String

Retrieve State

Returns the state of the oauth context for the parametrized resource owner ID

Parameters

Name Type Description Default Value Required

Token Manager

The token manager which holds the access token.

x 

Resource Owner Id

String

The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.

default

 

Output Mime Type

String

The mime type of the payload that this operation outputs.

 

Target Variable

String

The name of a variable on which the operation's output will be placed

 

Target Output

Enumeration, one of:

  • PAYLOAD

  • MESSAGE

The type of the operation's output that will be stored in the target variable

PAYLOAD

 

Output

Type

String

Types

Token Manager Config

Field Type Default Value

Object Store

Authorization Code Grant Type

Field Type Default Value

Local Callback Config

String

Local Callback Config Path

String

Local Callback Url

String

External Callback Url

String

State

String

Local Authorization Url Resource Owner Id

String

Local Authorization Url

String

Authorization Url

String

Custom Parameters

Object

Resource Owner Id

String

default

Client Id

String

Client Secret

String

Scopes

String

Token Manager

Token Url

String

Response Access Token

String

#[payload.access_token]

Response Refresh Token

String

#[payload.refresh_token]

Response Expires In

String

#[payload.expires_in]

Custom Parameter Extractors

Refresh Token When

Boolean

#[attributes.statusCode == 401 or attributes.statusCode == 403]

Tls Context Factory

Tls

Parameter Extractor

Field Type Default Value

Param Name

String

Value

String

Tls

Field Type Default Value

Enabled Protocols

String

Enabled Cipher Suites

String

Trust Store

Key Store

Trust Store

Field Type Default Value

Path

String

Password

String

Type

  • Enumeration, one of:

    • jks

    • jceks

    • pkcs12

  • String

Algorithm

String

Insecure

Boolean

Key Store

Field Type Default Value

Path

String

Type

  • Enumeration, one of:

    • jks

    • jceks

    • pkcs12

  • String

Alias

String

Key Password

String

Password

String

Algorithm

String

Client Credentials Grant Type

Field Type Default Value

Encode Client Credentials In Body

Boolean

false

Client Id

String

Client Secret

String

Scopes

String

Token Manager

Token Url

String

Response Access Token

String

#[payload.access_token]

Response Refresh Token

String

#[payload.refresh_token]

Response Expires In

String

#[payload.expires_in]

Custom Parameter Extractors

Refresh Token When

Boolean

#[attributes.statusCode == 401 or attributes.statusCode == 403]

Tls Context Factory

Tls