OAuth Module Reference - Mule 4

Object Store

An object store to store the OAuth context data.

String

Listener configuration to use instead of localCallbackUrl. Note that if using this configuration you must also provide a localCallbackConfigPath separately.

String

Local path for the listener created according to localCallbackConfig, not required if you use localCallbackUrl.

String

URL that enables Mule runtime engine (Mule) to automatically create an endpoint in the configured URL that stores the authentication code unless there is an endpoint already registered to manually extract the authorization code.

String

The OAuth authentication server uses the URL to provide the authentication code to the Mule server in order to retrieve the access token. Note that the URL must be the externally visible address of the callback, not the local address.

x

String

State parameter for holding state between the authentication request and the callback done by the OAuth authorization server to the redirectUrl.

String

Identifier to store the OAuth authentication attributes (accessToken, refreshToken, etc). This attribute is required only when applications access resources from more than one user in the OAuth authentication server.

String

URL that enables Mule to automatically create an endpoint in the host server for the user to authenticate and grant access to the application for their account.

x

String

The OAuth authentication server URL to authorize the app for a certain user.

x

Object

Custom parameters to send to the authorization request URL or the OAuth authorization sever.

String

Identifier to store the OAuth authentication attributes (accessToken, refreshToken, etc). This attribute is required only when applications access resources from more than one user in the OAuth authentication server.

default

Boolean

If true, the client ID and client secret are sent in the request body. Otherwise, the client ID and client secret are sent as basic authentication.

true

String

Application identifier defined in the OAuth authentication server.

x

String

Application secret defined in the OAuth authentication server.

x

String

Scope required by the application to execute. Scopes define permissions over resources.

Token Manager Config

The token manager configuration to use for the grant type.

String

The OAuth authentication server URL to get access to the token. Mule calls this URL to get the access token, after receiving the authentication code from the OAuth server through the redirectUrl.

x

String

Expression to extract the access token parameter from the response of the call to tokenUrl.

#[payload.access_token]

String

Response refresh token.

#[payload.refresh_token]

String

Expression to extract the expires in parameter from the response of the call to tokenUrl.

#[payload.expires_in]

Array of Parameter Extractor

Boolean

Enables expressions to evaluate against the HTTP response of the API callback to determine if the request failed because it was done using an expired token. If the evaluation returns true (access token expired), Mule automatically triggers a refresh token flow and retries the API callback using a new access token. Default value evaluates if the response status code is 401 or 403.

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

TLS

A TLS configuration to receive incoming HTTP requests and do HTTP requests during the OAuth dance.

String

Parameter extractor name.

x

String

Value for this type.

x

String

Comma-separated list of protocols enabled for this context.

String

Comma-separated list of cipher suites enabled for this context.

Truststore

Configures the TLS truststore.

Keystore

Configures the TLS keystore.

Revocation check configuration.

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

String

Password used to protect the truststore.

String

Type of store.

String

Encryption algorithm that the truststore uses.

Boolean

If true, Mule stops performing certificate validations. Setting this attribute to true make connections vulnerable to attacks.

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

String

Type of store.

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

String

Password used to protect the private key.

String

Password used to protect the keystore.

String

Encryption algorithm that the keystore uses.

Boolean

Which elements to verify in the certificate chain:

Boolean

How to check certificate validity:

Checks the Online Certificate Status Protocol (OCSP) for certificate validity.

Boolean

Whether to use the secondary method to check certificate validity:

Uses the method not specified in the Prefer Crls field to check the certificate validity.

Does not use the method specified in the Prefer Crls field to check certificate validity.

Boolean

What to do if the revocation server can’t be reached or is busy:

Avoids verification failure.

Enables the verification to fail.

String

URL of the OCSP responder.

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be configured in the truststore.

String

Path to the CRL file.

Boolean

If true, the client ID and client secret are sent in the request body. Otherwise, the client ID and client secret are sent as basic authentication.

false

String

Application identifier defined in the OAuth authentication server.

x

String

Application secret defined in the OAuth authentication server.

x

String

Scope required by the application to execute. Scopes define permissions over resources.

Token Manager Config

The token manager configuration to use for the grant type.

String

The OAuth authentication server URL to get access to the token. Mule calls this URL to get the access token, after receiving the authentication code from the OAuth server through the redirectUrl.

x

String

Expression to extract the access token parameter from the response of the call to tokenUrl.

#[payload.access_token]

String

Response refresh token.

#[payload.refresh_token]

String

Expression to extract the expires in parameter from the response of the call to tokenUrl.

#[payload.expires_in]

Array of Parameter Extractor

Custom parameter extractors configuration.

Boolean

Enables expressions to evaluate against the HTTP response of the API callback to determine if the request failed because it was done using an expired token. If the evaluation returns true (access token expired), Mule automatically triggers a refresh token flow and retries the API callback using a new access token. Default value evaluates if the response status code is 401 or 403.

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

TLS

A TLS configuration to receive incoming HTTP requests and do HTTP requests during the OAuth dance.