Connections

ConnectionsService

Service for managing UiPath external service connections.

This service provides methods to retrieve direct connection information retrieval and secure token management.

retrieve

retrieve(key)

Retrieve connection details by its key.

This method fetches the configuration and metadata for a connection, which can be used to establish communication with an external service.

Parameters:

Name	Type	Description	Default
key	str	The unique identifier of the connection to retrieve.	required

Returns:

Name	Type	Description
Connection	Connection	The connection details, including configuration parameters and authentication information.

retrieve_async async

retrieve_async(key)

Asynchronously retrieve connection details by its key.

This method fetches the configuration and metadata for a connection, which can be used to establish communication with an external service.

Parameters:

Name	Type	Description	Default
key	str	The unique identifier of the connection to retrieve.	required

Returns:

Name	Type	Description
Connection	Connection	The connection details, including configuration parameters and authentication information.

retrieve_token

retrieve_token(key)

Retrieve an authentication token for a connection.

This method obtains a fresh authentication token that can be used to communicate with the external service. This is particularly useful for services that use token-based authentication.

Parameters:

Name	Type	Description	Default
key	str	The unique identifier of the connection.	required

Returns:

Name	Type	Description
ConnectionToken	ConnectionToken	The authentication token details, including the token value and any associated metadata.

retrieve_token_async async

retrieve_token_async(key)

Asynchronously retrieve an authentication token for a connection.

This method obtains a fresh authentication token that can be used to communicate with the external service. This is particularly useful for services that use token-based authentication.

Parameters:

Name	Type	Description	Default
key	str	The unique identifier of the connection.	required

Returns:

Name	Type	Description
ConnectionToken	ConnectionToken	The authentication token details, including the token value and any associated metadata.