META-INF.mule-oauth2.xsd Maven / Gradle / Ivy
The newest version!
OAuth configuration for authenticate using OAuth 2.0 grant type authorization code.
OAuth configuration for authenticate using OAuth 2.0 grant type client credentials.
TLS config that will be used to receive incoming HTTP request and do HTTP request during the OAuth dance.
This element configures an automatic flow created by mule to handle
This element configures an automatic flow created by mule that listens in the configured
url by the redirectUrl attribute and process the request to
retrieve an access token from the oauth authentication server.
Application identifier as defined in the oauth authentication server.
Application secret as defined in the oauth authentication server.
The oauth authentication server will use this url to provide the authentication code to the
Mule server so it can retrieve the access token.
If this attribute is provided mule will automatically create an endpoint at this url to
be able to store the authentication code unless there’s already an endpoint registered
to manually extract the authorization code.
This is the redirection url to send to the user, and must match the one configured in the
oauth authentication server. It won't create an endpoint by itself, and should be used
when the external callback address is different from the local one.
Identifier under which the oauth authentication attributes are stored (accessToken,
refreshToken, etc).
This attribute is only required when the applications needs to access resources from more
than one user in the OAuth authentication server.
A MEL expression can be used and it will be evaluated against the request done to
localAuthorizationUrl in the authorization-request element.
Identifier under which the oauth authentication attributes are stored (accessToken,
refreshToken, etc).
This attribute is only required when the applications needs to access resources from more
than one user in the OAuth authentication server.
A MEL expression can be used and it will be evaluated against the message to be sent by the
http:request element.
The token manager configuration to use for this grant type.
References a TLS config that will be used to receive incoming HTTP request and do HTTP request during the OAuth dance.
TLS config that will be used to do the HTTP request during the OAuth dance.
This element configures an automatic flow created by mule that listens in the configured
url by the redirectUrl attribute and process the request to
retrieve an access token from the oauth authentication server.
Application identifier as defined in the oauth authentication server.
Application secret as defined in the oauth authentication server.
The token manager configuration to use for this grant type.
References a TLS config that will be used to receive incoming HTTP request and do HTTP request during the OAuth dance.
Configures how to handle the response from the call to tokenUrl. Allows to define expressions to
extract parameters from the response.
The oauth authentication server url to get access to the token. Mule, after receiving the
authentication code from the oauth server (through the redirectUrl) will
call this url to get the access token.
After executing an API call authenticated with OAuth it may be that the access token used was
expired, so this attribute allows a
MEL expressions that will be evaluated against the http response of the API callback to determine if
the request failed because it was done
using an expired token. In case the evaluation returns true (access token expired) then mule will
automatically trigger a refresh token flow and retry
the API callback using a new access token. Default value evaluates if the response status code was
401 or 403.
Configures how to handle the response from the call to tokenUrl. Allows to define expressions to
extract parameters from the response.
The oauth authentication server url to get access to the token. Mule, after receiving the
authentication code from the oauth server (through the redirectUrl) will
call this url to get the access token.
If true, the client id and client secret will be sent in the request body. Otherwise, they will be sent as basic authentication.
After executing an API call authenticated with OAuth it may be that the access token used was
expired, so this attribute allows a
MEL expressions that will be evaluated against the http response of the API callback to determine if
the request failed because it was done
using an expired token. In case the evaluation returns true (access token expired) then mule will
automatically trigger a refresh token flow and retry
the API callback using a new access token. Default value evaluates if the response status code was
401 or 403.
Scope required by this application to execute. Scopes define permissions over resources.
Configures a custom parameter that must be extracted from the response of the tokenUrl url call.
MEL expression to extract the access token parameter.
MEL expression to extract the refresh token parameter.
MEL expression to extract the expired in parameter.
Configures a custom parameter that must be extracted from the response of the tokenUrl url call.
MEL expression to extract the access token parameter.
MEL expression to extract the expired in parameter.
Identifier under which the extracted value will be stored in the OAuth authentication state.
MEL expression to extract the parameter value. This value can be later used by using the
oauthContext function.
Custom parameters to send to the authorization request url or the oauth authorization sever.
If this attribute is provided mule will automatically create and endpoint in the host server that
the user can hit to authenticate and grant access to the application for his account.
The oauth authentication server url to authorize the app for a certain user.
Scope required by this application to execute. Scopes define permissions over resources.
State parameter for holding state between the authentication request and the callback done by the
oauth authorization server to the redirectUrl.
Name of the additional query parameter.
Value for the request parameter. It can be a MEL expression that will be evaluated
against the message received by the localAuthenticationUrl url.
Manages the information from the oauth authorization like access token, refresh token an custom parameters.
References an object store to use for storing oauth context data
Identifier for the token manager configuration.
Clears all te oauth context information.
The token manager which holds the credentials to invalidate
The resource owner id to invalidate. This attribute is only allowed for authorization code grant type.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy