Desktop flows

Enables desktop flows (previously called UI flows)

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions
Power Apps Premium All Power Apps regions
Power Automate Premium All Power Automate regions
Connector Metadata
Publisher Microsoft

Creating a connection

The connector supports the following authentication types:
Connect using credentials with a service principal as run owner Connect using credentials with a service principal as run owner All regions Not shareable
Connect with sign in - Attended Connect with sign in - Attended All regions Not shareable
Connect with username and password Connect with username and password All regions Not shareable
Default [DEPRECATED] This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. All regions Not shareable

Connect using credentials with a service principal as run owner

Auth ID: azureRelayRunOwner

Applicable: All regions

Connect using credentials with a service principal as run owner

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Machine or machine group string Select the machine or machine group to connect to True
User account string Format as domain\username or username@domain.com True
Password securestring Password credential True
Client ID string True
Client certificate secret clientCertificate The client certificate secret used for the Service Principal authentication True

Connect with sign in - Attended

Auth ID: passwordlessAttended

Applicable: All regions

Connect with sign in - Attended

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Machine or machine group string Select the machine or machine group to connect to True

Connect with username and password

Auth ID: azureRelay

Applicable: All regions

Connect with username and password

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Machine or machine group string Select the machine or machine group to connect to True
User account string Format as domain\username or username@domain.com True
Password securestring Password credential True

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
User account securestring Format as domain\username or username@domain.com True
Password securestring Password credential True

Throttling Limits

Name Calls Renewal Period
API calls per connection 700 60 seconds
Non-Get requests per connection 300 3600 seconds

Actions

Run a flow built with Power Automate for desktop

A flow will automatically run a set of steps built by Power Automate for desktop.
Run a flow built with Windows recorder V1 (deprecated) [DEPRECATED]

A flow will automatically run a set of steps recorded in a single app using Windows recorder (V1) (deprecated).
Run a test session

Runs a test session with specified test cases.

Run a flow built with Power Automate for desktop

Operation ID:
RunUIFlow_V2

A flow will automatically run a set of steps built by Power Automate for desktop.

Parameters

Name Key Required Type Description
Desktop flow
 uiFlowId True string

Choose an option or create your own
Run Mode
 runMode True string

Choose between running while signed in (attended) or in the background (unattended).
Attended Mode
 runSession string

When "Attended" Run Mode is selected, run on desktop or in picture-in-picture
Video Logs
 videoLogger string

Enable or disable video log capture when running in "Unattended" mode.
Priority
 runPriority string

Choose an option or add your own
item
 item True dynamic

The inputs.

Returns

The outputs of this operation are dynamic.

Run a flow built with Windows recorder V1 (deprecated) [DEPRECATED]

Operation ID:
ExecuteDesktopUIFlow

A flow will automatically run a set of steps recorded in a single app using Windows recorder (V1) (deprecated).

Parameters

Name Key Required Type Description
Desktop flow
 uiFlowId True string

Choose an option or create your own
Run Mode
 runMode string

Choose between running while signed in (attended) or in the background (unattended).
Priority
 runPriority string

Choose an option or add your own
item
 item dynamic

The inputs.

Returns

The outputs of this operation are dynamic.

Run a test session

Operation ID:
ExecuteTestSessionWithTestCases

Runs a test session with specified test cases.

Parameters

Name Key Required Type Description
Run Mode
 runMode True string

Choose between running while signed in (attended) or in the background (unattended).
Attended Mode
 runSession string

When "Attended" Run Mode is selected, run on desktop or in picture-in-picture
Priority
 runPriority string

Whether test cases should run with <high> or <normal> priority. Defaults to <normal>.
testCases
 testCases True array of string

Returns

Test session completed.

Body
GetTestStatusResponse

Definitions

GetTestStatusResponse

Test session completed.

Name Path Type Description
testSessionId
 testSessionId string

Test session record id in Dataverse
status
 status string

Overall final test session status
testCases
 testCases array of object
testCaseId
 testCases.testCaseId string

Desktop flow record id in Dataverse
flowSessionId
 testCases.flowSessionId string

Flow session record id in Dataverse
statusCode
 testCases.statusCode string

Status code for the flow session
errorCode
 testCases.errorCode string

Error code for the flow session (or empty/undefined in case of success)