integration-service
latest
false
UiPath logo, featuring letters U and I in white

Integration Service user guide

Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Feb 6, 2025

Getting started

You can create a custom connector from a blank canvas or from an API specification.

Before you create a connector, first familiarize yourself with the available authentication types.

Authentication types

This section explains the most common authentication types available in Connector Builder. It includes a comparison between three authentication types in terms of use case, authentication flow, and security. For further details, refer to Authentication types.

OAuth 2.0 Authorization code flow

  • Ideal for applications that need to access user data on behalf of the user.
  • High security: the access token is never exposed to the user agent and is exchanged server-to-server.

Flow:

  1. User authorization: The user is redirected to the authorization server to grant access.
  2. Authorization code: If the user grants access, an authorization code is returned to the client.
  3. Token exchange: The client exchanges the authorization code for an access token at the token endpoint.

OAuth 2.0 Client credentials code flow

  • Suitable for server-to-server interactions where no user interaction is involved.
  • Moderate security: it relies on the client credentials being kept secure.

Flow:

  1. Direct token request: The client directly requests an access token from the authorization server using its client credentials.
  2. Access token: The authorization server returns an access token

API key

  • Simple and quick to implement, often used for public APIs.
  • Low security: API keys can be easily shared or exposed.

Flow:

API Key Usage: The user includes an API key in each request to authenticate.

Choosing an authentication flow

In Example A: Build a connector from a blank canvas with Personal Access Token authentication we use the Personal Access Token (PAT) authentication type. The Generate Image API example follows the standard practice of using the Authorization header with the Bearer scheme for the API key, especially for OAuth 2.0 tokens.

Some APIs, such as SAP S4 ODataV2 resources, use a custom header like API Key to authenticate the application. This is used in Example B: Build a connector from a blank canvas with API key authentication.

Example C: Build a connector from an API specification with OAuth 2.0 Client credentials authentication uses OAuth 2.0 Client credentials flow, with an OAuth 2.0 application.

  • Authentication types
  • OAuth 2.0 Authorization code flow
  • OAuth 2.0 Client credentials code flow
  • API key
  • Choosing an authentication flow

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo White
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2025 UiPath. All rights reserved.