Integration Service user guide

Prerequisites​

UiPath User Access Token​

OAuth 2.0 Authorization code​

• Connection name - A descriptive name to help you identify this connection.
• Base URL - The base URL of your API (e.g. https://api.example.com).
• Client ID - The unique identifier for your application as provided by your OAuth provider during app registration.
• Client secret - The confidential secret key for your application as provided by your OAuth provider.
• Authorization URL - The full authorization endpoint URL as provided by your OAuth provider (e.g. https://login.example.com/oauth2/authorize).
• Token URL - The token endpoint URL where authorization codes or credentials are exchanged for access tokens as provided by your OAuth provider (e.g. https://login.example.com/oauth2/token).
• Scope - The required OAuth scopes based on your API provider or integration needs.

• Refresh token URL - The refresh token endpoint URL as provided by your OAuth provider (e.g. https://example.com/docs/oauth/refresh)
• Token revoke URL - The token revocation endpoint URL as provided by your OAuth provider (https://example.com/docs/oauth/revoke).
• Refresh interval - Time in seconds between OAuth token refresh attempts.
• OAuth basic header - Enable to send Client ID and Secret as a basic authentication header during OAuth token exchange. Most providers need this enabled.

OAuth 2.0 Authorization code with PKCE​

• Connection name - A descriptive name to help you identify this connection.
• Base URL - The base URL of your API (e.g. https://api.example.com).
• Client ID - The unique identifier for your application as provided by your OAuth provider during app registration.
• Client secret - The confidential secret key for your application as provided by your OAuth provider.
• Authorization URL - The full authorization endpoint URL as provided by your OAuth provider (e.g. https://login.example.com/oauth2/authorize).
• Token URL - The token endpoint URL where authorization codes or credentials are exchanged for access tokens as provided by your OAuth provider (e.g. https://login.example.com/oauth2/token).
• Scope - The required OAuth scopes based on your API provider or integration needs.

• Refresh token URL - The refresh token endpoint URL as provided by your OAuth provider (e.g. https://example.com/docs/oauth/refresh)
• Token revoke URL - The token revocation endpoint URL as provided by your OAuth provider (https://example.com/docs/oauth/revoke).
• Refresh interval - Time in seconds between OAuth token refresh attempts.
• OAuth basic header - Enable to send Client ID and Secret as a basic authentication header during OAuth token exchange. Most providers need this enabled.

OAuth 2.0 Client credentials​

• Connection name - A descriptive name to help you identify this connection.
• Base URL - The base URL of your API (e.g. https://api.example.com).
• Client ID - The unique identifier for your application as provided by your OAuth provider during app registration.
• Client secret - The confidential secret key for your application as provided by your OAuth provider.
• Token URL - The token endpoint URL where authorization codes or credentials are exchanged for access tokens as provided by your OAuth provider (e.g. https://login.example.com/oauth2/token).
• Scope - The required OAuth scopes based on your API provider or integration needs.

• Refresh interval - Time in seconds between OAuth token refresh attempts.
• OAuth basic header - Enable to send Client ID and Secret as a basic authentication header during OAuth token exchange. Most providers need this enabled.

OAuth 2.0 Password​

• Connection name - A descriptive name to help you identify this connection.
• Base URL - The base URL of your API (e.g. https://api.example.com).
• Username - The end-user's username credential for authentication.
• Password - The end-user's password credential for authentication.
• Client ID - The unique identifier for your application as provided by your OAuth provider during app registration.
• Client secret - The confidential secret key for your application as provided by your OAuth provider.
• Authorization URL - The full authorization endpoint URL as provided by your OAuth provider (e.g. https://login.example.com/oauth2/authorize).
• Token URL - The token endpoint URL where authorization codes or credentials are exchanged for access tokens as provided by your OAuth provider (e.g. https://login.example.com/oauth2/token).
• Scope - The required OAuth scopes based on your API provider or integration needs.

• Refresh token URL - The refresh token endpoint URL as provided by your OAuth provider (e.g. https://example.com/docs/oauth/refresh).
• Token revoke URL - The token revocation endpoint URL as provided by your OAuth provider (https://example.com/docs/oauth/revoke).
• Refresh interval - Time in seconds between OAuth token refresh attempts.
• OAuth basic header - Enable to send Client ID and Secret as a basic authentication header during OAuth token exchange. Most providers need this enabled.

Basic Authentication​

• Connection name - A descriptive name to help you identify this connection.
• Base URL - The base URL of your API (e.g. https://api.example.com).
• Username - The username credential for your API account.
• Password - The password credential for your API account.

• Authentication validation API - Enter the relative path that will be used to verify your authentication credentials (e.g. /api/v1/me, /user/profile, /auth/validate). This API route should return a successful response when your credentials are valid.

API Key​

• Connection name - A descriptive name to help you identify this connection.
• Base URL - The base URL of your API (e.g. https://api.example.com).
• Parameter name - The exact name of the API key parameter as required by your API (e.g. X-API-Key, api_key, Authorization). This will be used as either a header name or query parameter name based on your selection.
• Value - Your complete API key value as provided by your API provider. This will be securely stored and used for authentication.

• Add to - Select whether to add the API key in the request header or as a query parameter. Header is recommended for better security.
• Authentication validation API - Enter the relative path that will be used to verify your authentication credentials (e.g. /api/v1/me, /user/profile, /auth/validate). This API route should return a successful response when your credentials are valid.

OAuth 2.0 JWT Bearer​

• Connection name - A descriptive name to help you identify this connection.
• Base URL - The base URL of your API (e.g. https://api.example.com).
• Client ID - The unique identifier for your application as provided by your OAuth provider during app registration.
• Client secret - The confidential secret key for your application as provided by your OAuth provider.
• JWT base64 encoded key - Your Base64-encoded private key. Ensure you follow your API provider's instructions for key generation and encoding.
• Authorization URL - The full authorization endpoint URL as provided by your OAuth provider (e.g. https://login.example.com/oauth2/authorize).
• Token URL - The token endpoint URL where authorization codes or credentials are exchanged for access tokens as provided by your OAuth provider (e.g. https://login.example.com/oauth2/token).
• Scope - The required OAuth scopes based on your API provider or integration needs.

• Refresh token URL - The refresh token endpoint URL as provided by your OAuth provider (e.g. https://example.com/docs/oauth/refresh).
• Token revoke URL - The token revocation endpoint URL as provided by your OAuth provider (https://example.com/docs/oauth/revoke).
• Refresh interval - Time in seconds between OAuth token refresh attempts.
• OAuth basic header - Enable to send Client ID and Secret as a basic authentication header during OAuth token exchange. Most providers need this enabled.

Personal Access Token​

• Connection name - A descriptive name to help you identify this connection.
• Base URL - The base URL of your API (e.g. https://api.example.com).
• Token prefix - The token prefix (e.g. Bearer, Token, Basic). This will be combined with your token in the Authorization header. Leave empty if no prefix is required.
• Token - The complete personal access token value. This will be combined with the token type in the Authorization header (e.g. Bearer your-token-here).

• Authentication validation API - Enter the relative path that will be used to verify your authentication credentials (e.g. /api/v1/me, /user/profile, /auth/validate). This API route should return a successful response when your credentials are valid.

Add the HTTP connection​

1. Select Integration Service from the left rail.
2. From the Connectors list, select HTTP. You can also use the search bar to find the connector.
3. Select the Connect to HTTP button.
4. In the connection screen, provide the required details.
5. Select Connect.
6. Your connection has been added.