Create an OAuth 2.0 iClient resource – Celigo Help Center

Rate this feature
Included in the Jan. 2023 release Use an iClient when authenticating your HTTP connection with OAuth 2.0. OAuth 2.0 iClients are available in the Resources menu → iClient. You can use a single OAuth 2.0 iClient for multiple connections if they have the same provider.

To create an OAuth 2.0 iClient, fill in the required fields:

Fields	Description
Client ID	Enter your client ID as found in your application.
Client secret	Enter the client secret as found in your application. Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s secret safe. When editing this form later, you must generate this value again; it is stored only when the connection is saved and never displayed as text.
Grant type	OAuth 2.0 authentication currently supports two grant types: authorization code and client credentials. Choose Authorization code to use an authorization server to obtain an authorization code as an intermediary between the client and resource owner. Choose Client credentialsif authorization scopes are limited to protected resources under the control of the client or previously configured on the authorization server.
Authorization code	The provided code is obtained by using an authorization server as an intermediary between the client, integrator.io, and resource owner. Selecting Authorization code enables additional required and informational settings
	Send client credentials via	Sends a basic auth request in the header or client credentials in the request body.
	Authorization URL	This is the authorization code retrieval endpoint on the API provider’s authorization server.
	Access token URL	integrator.io retrieves the access token from this URL.
	Valid domain names	integrator.io validates the HTTP requests sent to various OAuth URLs using the domain name value. If the Authorization URL, access token URL and revoke token URL have different domain names, provide them as comma-separated values in any order.
Client credentials	Limits the authorization scope to the protected resources under the control of the client, or to protected resources previously arranged with the authorization server. Selecting Client credentials exposes one additional required setting.
	Send client credentials via	Sends a basic auth request in the header or client credentials in the request body.
	Access token URL	integrator.io retrieves the access token from this URL.
	Revoke token URL	integrator.io makes an HTTP post request to the token revocation endpoint URL to revoke a particular token.
	Valid domain names	integrator.io validates the HTTP requests sent to various OAuth URLs using the domain name value. If the Authorization URL, access token URL and revoke token URL have different domain names, provide them as comma-separated values in any order.

OAuth 2.0 overrides

Field	Description
Override access token HTTP headers	In some rare cases, it may be necessary to include custom HTTP headers with your API requests. The default content-type header value is `application/x-www-form-urlencoded`. Enter a name and a value to replace default header values with custom values.
Override access token request body	Configure your own access token body in JSON format if it is different from the default access token body. This JSON format is finally converted to the form-urlencoded format on the wire. Default access token body format if `'Client Authentication'` set as `'body'`: `{ code: {{{query.code}}}, redirect_uri: {{{redirectUri}}}, client_id: {{{clientId}}}, client_secret: {{{clientSecret}}}, grant_type: “authorization_code”}.` Default access token body format if 'Client Authentication' set as `'header'`: `{ client_id: {{{clientId}}}, client_secret: {{{clientSecret}}} grant_type: “client_credentials” }`.
Override revoke token HTTP headers	In some rare cases, you may need to include custom HTTP headers with your API requests. The default content-type header value is `application/x-www-form-urlencoded`, and the authorization header value is basic.
Override revoke token HTTP body	Configure your own revoke body in JSON format if it is different from the default revoke token body. This JSON format is finally converted to the form-urlencoded format on the wire. Default revoke body format:`{ token: {{{connection.http.auth.token.token}}} }.`

OAuth 2.0 overrides

Related articles