Documentation Index

Fetch the complete documentation index at: https://documentation.encodify.com/llms.txt

Use this file to discover all available pages before exploring further.

Custom OAuth2 Service (Custom HTTP)

Prev Next

Overview


Important: The Custom OAuth2 Service (Custom HTTP) will be enabled by default within your infrastructure. It does NOT require an Encodify administrator to apply any adjustments to your infrastructure


Service can be used for authorising the third-party system, which requires OAuth 2.0 for access.

Parameter

Description

Service Name

Descriptive name of the integration service. The name will be displayed in the configuration of the “Send to connected service” action

Account

You can select from existing accounts or leave “Create new…” to create the new one on this step

Account Name

Descriptive name of the connected account

Client ID

ID of the Client Application configured in your external Identity Provider account

Client Secret

Secret code of the Client Application configured in your external Identity Provider account

Client Auth Method

Used for specifying the way authentication data is sent to request an access token.

Access Token URI

Used for getting an access token from the third-party system provider

Scope

A comma-separated list of scopes. This setting defines which data, needed for authentication, will be requested. For exact values, see the documentation of your authorisation service

Scope is always required regardless of bearer token type or grant type.

Bearer token type

Default value: Access token

Bearer token type depends on the OAuth provider's settings.

Grant type

The way the Encodify system will receive the access token from the external provider:

Client Credentials — only client ID and Secret are required.

Password — requires additionally sending the user's login and password.

User Name

Third-party system user login name.

For Grant, type "Password" only.

Password

Third-party system user password.

For Grant, type "Password" only.

Once the service is configured, it can be used in Copy to HTTP Server action setting by enabling the "Authenticate With Connected Service" option.  

Note!

Starting from version 15, Custom Oauth2 service is moved to the generic Custom HTTP connected service, where Oauth2 can be configured by selecting Oauth2 header as Authorization type. Follow the link for more details on configuration.