add-ins
latest
false
UiPath logo, featuring letters U and I in white

Add-ins User Guide

Last updated Jul 17, 2024

Connection Types

UiPath Auth Connection Provider

Parameters

Name

Type

Description

Default Value

Required

Default

Headers

Array of Default Header

   

Query Parameters

Array of Default Query Parameter

   

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

 

Connection

Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Connection Timeout

SECONDS

 

Use Persistent Connections

Boolean

If false, each connection isclosed after the first request is completed.

true

 

Max Connections

Number

The maximum number of outbound connections that are kept open at the same time.

-1

 

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed.

30

 

Connection

Idle Timeout

Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

 

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy.

  

Stream Response

Boolean

Whether or not received responses should be streamed.

false

 

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response is stored.

-1

 

Base Uri

String

Parameter base URI, each instance/tenant gets its own.

 

Yes

TLS

Configuration

Tls

   

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all add-ins. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

  

Client Id

String

The OAuth client id as registered with the service provider.

 

Yes

Client Secret

String

The OAuth client secret as registered with the service provider.

 

Yes

Token Url

String

The service provider’s token endpoint URL.

https://cloud.uipath.com/identity_/connect/token

 

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation.

  

Object Store

String

A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime automatically provisions the default one.

  
  • UiPath Auth Connection Provider

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.