OAuth Endpoints Reference
This is a reference for the OAuth Endpoints integration. The endpoint configuration follows a similar pattern to the REST Endpoint integration, with additional OAuth2.0/ODIC specific parameters.
Endpoint Name
A unique name for the endpoint for use in Workflow Engine configuration.
Type | String |
Required | Yes |
Default | N/A |
URL
URL of the endpoint. Used to request an authorization token.
Type | String |
Required | Yes |
Default | N/A |
Timeout
Length of time to wait before halting a connection or read attempt, in seconds.
Type | Integer |
Required | Yes |
Default |
|
Client Credentials in Header
Check to place any client credentials (client_id and client_secret parameters) in a basic auth header rather than the body
Type | Boolean |
Required | No |
Default |
|
Parameters
Grant Type
The integration support two grant types suitable for machine to machine communication.
Type | One of: |
Required | Yes |
Default |
|
Username
When the password grant type is selected, this field contains the username of the associated user. When the client_credentials grant type is selected, this field isn’t displayed.
Type | String |
Required | Yes, when the grant type is |
Default | N/A |
Password
When the password grant type is selected, this field contains the password of the associated user. When the client_credentials grant type is selected, this field isn’t displayed.
Type | String |
Required | Yes, when the grant type is |
Default | N/A |
Client Id
The client_id to use for client authentication. This is a required field when the client_credentials grant type is selected. For the password grant type this is an optional field which is only required if client authentication is used.
Type | String |
Required | Yes, when the grant type is |
Default | N/A |
Client Secret
The client_secret to use for client authentication. This is a required field when the client_credentials grant type is selected. For the password grant type this is an optional field which is only required if client authentication is used.
Type | String |
Required | Yes, when the grant type is |
Default | N/A |
Additional Parameters
Any additional parameters you want to add to the request. Click Add Parameter to configure an additional parameter.
Name
Parameter name.
Type | String |
Required | No |
Default | N/A |
Value
Parameter Value
Type | String |
Required | No |
Default | N/A |
Headers
Content-type
Specifies the format of the response. This is a read-only field and should not normally be changed, however the Other field allows you to specify an alternative, if required.
Type | String |
Required | Yes |
Default |
|
Other
Allows you to specify a content-type other than those available in the Content-type drop-down.
Type | String |
Required | No |
Default | N/A |
Additional Headers
Any additional headers you want to add to the request. Click Add Header to configure an additional header. Cannot currently contain substitutions.
Name
Header name.
Type | String |
Required | No |
Default | N/A |
Value
Header value.
Type | String |
Required | No |
Default | N/A |
Security
Disable Certificate Validation
Specifies whether to disable SSL certificate validation. If set to Yes, the data transmission between Moogsoft Enterprise and the endpoint is not protected by the encryption protocol.
Type | Boolean |
Required | Yes |
Default |
|
Authentication
Username
Basic authentication username.
Type | String |
Required | Yes, if using Basic Authentication |
Default | N/A |
Password
Basic authentication password.
Type | String |
Required | Yes, if using Basic Authentication |
Default | N/A |
Proxy settings
Specifies connection details for a proxy server if you want to connect to the external system through a proxy.
Use proxy in request
Type | Boolean |
Required | Yes |
Default | No |
Proxy host
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy user
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy port
Type | Integer |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy password
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |