Flow management

Enables interaction with flow management service.

This connector is available in the following products and regions:

Service Class Regions
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Create Connection

Create a connection for the given connector in an environment.

Create Flow

Create flow

Delete Flow

Delete the given flow in an environment

Get Connector

Get the given connector in an environment.

Get Flow

Get the given flow in an environment.

Get Flow as Admin

Get the given flow from an environment you have admin access to.

List Connectors

Lists all of the connectors available in the given environment. This list will include custom connectors as well as the built-in connectors.

List Flow Owners

List all owners of the given flow in an environment.

List Flow Run-Only Users

List all run only users of the given flow in an environment.

List Flows as Admin

List all flows in the given environment you have admin access to.

List My Connections

Lists all your connection available in the given environment.

List My Environments

List the environments you have access to.

List My Flows

List all flows you created in the given environment.

Modify Flow Owners

Modify owners of the given flow in an environment.

Modify Flow Owners as Admin

Modify owners of the given flow created in an environment you have admin access to.

Modify Run-Only Users

Modify run-only users of the given flow in an environment.

Turn Off Flow

Stop the given flow in an environment.

Turn On Flow

Start the given flow in an environment.

Update Flow

Update the given flow in an environment.

Create Connection

Create a connection for the given connector in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Connector
apiName True string

Select connector

connection
connection dynamic

Connection

Returns

The outputs of this operation are dynamic.

Create Flow

Create flow

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow Name
name string

Select environment

Flow Display Name
displayName True string

Select environment

Flow State
state True string

Select environment

Connection Name
connectionName True string

Select environment

Connection Display Name
displayName string

Select environment

Connector Id
id True string

Select environment

Connector Name
name string

Select environment

Connector Display Name
displayName string

Select environment

Connection Created Time
createdTime date-time

Select environment

Connector Runtime Url
primaryRuntimeUrl string

Select environment

Connector Icon Url
iconUri string

Select environment

Connector is Custom Api
isCustomApi boolean

Select environment

Connector Tier
tier string

Select environment

Flow Created Time
createdTime date-time

Select environment

Flow Modified Time
lastModifiedTime date-time

Select environment

Flow Template Name
templateName string

Select environment

Flow Trigger Uri
flowTriggerUri string

Select environment

Flow Installation Status
installationStatus string

Select environment

Creator tenant ID
tenantId True string

Select environment

Creator object ID
objectId string

Select environment

Creator user ID
userId True string

Select environment

Creator user type
userType True string

Select environment

Flow trigger type
type string

Select environment

Flow trigger kind
kind string

Select environment

Action type
type string

Select environment

Swagger operation Id
swaggerOperationId string

Select environment

Action Api name
name string

Select environment

Action Api id
id string

Select environment

Action Api type
type string

Select environment

Returns

Body
Flow

Delete Flow

Delete the given flow in an environment

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Get Connector

Get the given connector in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Connector
apiName True string

Select connector

Returns

The outputs of this operation are dynamic.

Get Flow

Get the given flow in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Returns

Get Flow as Admin

Get the given flow from an environment you have admin access to.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Returns

List Connectors

Lists all of the connectors available in the given environment. This list will include custom connectors as well as the built-in connectors.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Returns

List Flow Owners

List all owners of the given flow in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Returns

List Flow Run-Only Users

List all run only users of the given flow in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Returns

List Flows as Admin

List all flows in the given environment you have admin access to.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Top count
$top integer

Top count

Returns

List My Connections

Lists all your connection available in the given environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Returns

List My Environments

List the environments you have access to.

Returns

List My Flows

List all flows you created in the given environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Returns

Modify Flow Owners

Modify owners of the given flow in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Add User Object Id
id True string

Select environment

Add User Type
type True string

Select environment

Remove User Object Id
id True string

Select environment

Remove User Type
type True string

Select environment

Modify Flow Owners as Admin

Modify owners of the given flow created in an environment you have admin access to.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Add User Object Id
id True string

Select environment

Add User Type
type True string

Select environment

Remove User Object Id
id True string

Select environment

Remove User Type
type True string

Select environment

Modify Run-Only Users

Modify run-only users of the given flow in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Add User Object Id
id True string

Select environment

Add User Type
type True string

Select environment

Remove User Object Id
id True string

Select environment

Remove User Type
type True string

Select environment

Turn Off Flow

Stop the given flow in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Turn On Flow

Start the given flow in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Update Flow

Update the given flow in an environment.

Parameters

Name Key Required Type Description
Environment
environmentName True string

Select environment

Flow
flowName True string

Select flow

Flow Name
name string

Select environment

Flow Display Name
displayName True string

Select environment

Flow State
state True string

Select environment

Connection Name
connectionName True string

Select environment

Connection Display Name
displayName string

Select environment

Connector Id
id True string

Select environment

Connector Name
name string

Select environment

Connector Display Name
displayName string

Select environment

Connection Created Time
createdTime date-time

Select environment

Connector Runtime Url
primaryRuntimeUrl string

Select environment

Connector Icon Url
iconUri string

Select environment

Connector is Custom Api
isCustomApi boolean

Select environment

Connector Tier
tier string

Select environment

Flow Created Time
createdTime date-time

Select environment

Flow Modified Time
lastModifiedTime date-time

Select environment

Flow Template Name
templateName string

Select environment

Flow Trigger Uri
flowTriggerUri string

Select environment

Flow Installation Status
installationStatus string

Select environment

Creator tenant ID
tenantId True string

Select environment

Creator object ID
objectId string

Select environment

Creator user ID
userId True string

Select environment

Creator user type
userType True string

Select environment

Flow trigger type
type string

Select environment

Flow trigger kind
kind string

Select environment

Action type
type string

Select environment

Swagger operation Id
swaggerOperationId string

Select environment

Action Api name
name string

Select environment

Action Api id
id string

Select environment

Action Api type
type string

Select environment

Returns

Body
Flow

Definitions

ResourceArray[ApiWithoutConnectionParameters]

Name Path Type Description
value
value array of ApiWithoutConnectionParameters

ResourceArray[ConnectionWithoutConnectionParameters]

Name Path Type Description
value
value array of ConnectionWithoutConnectionParameters

ResourceArray[Environment]

Name Path Type Description
value
value array of Environment

ResourceArray[AdminFlow]

Name Path Type Description
value
value array of AdminFlow

ResourceArray[FlowPermission]

Name Path Type Description
value
value array of FlowPermission

FlowPermission

Name Path Type Description
Permission Name
name string
properties
properties PermissionProperties

PermissionProperties

Name Path Type Description
roleName
roleName string
principal
principal Principal

Principal

Name Path Type Description
Object Id
id string
Display Name
displayName string
Email
email string
Type
type string
Tenant Id
tenantId string
Principal Name
userPrincipalName string
Owner Thumbnail Photo
thumbnailPhoto string

Flow

Name Path Type Description
Flow Name
name string
properties
properties FlowProperties

FlowProperties

Name Path Type Description
Flow Display Name
displayName string
Flow State
state string
connectionReferences
connectionReferences ConnectionReferencesDictionary
Flow Created Time
createdTime date-time
Flow Modified Time
lastModifiedTime date-time
Flow Template Name
templateName string
Flow Trigger Uri
flowTriggerUri string
Flow Installation Status
installationStatus string

FlowWithConnectionReferences

Name Path Type Description
Flow Name
name string
properties
properties FlowWithConnectionReferencesProperties

FlowWithConnectionReferencesProperties

Name Path Type Description
Flow Display Name
displayName string
Flow State
state string
connectionReferences
connectionReferences ConnectionReferencesArray
Flow Created Time
createdTime date-time
Flow Modified Time
lastModifiedTime date-time
Flow Template Name
templateName string
Flow Trigger Uri
flowTriggerUri string
Flow Installation Status
installationStatus string
creator
creator UserIdentity
definitionSummary
definitionSummary DefinitionSummary

AdminFlow

Name Path Type Description
Flow Name
name string
properties
properties AdminFlowProperties

AdminFlowProperties

Name Path Type Description
Flow Display Name
displayName string
Flow State
state string
connectionReferences
connectionReferences ConnectionReferencesDictionary
Flow Created Time
createdTime date-time
Flow Modified Time
lastModifiedTime date-time
Flow Template Name
templateName string
Flow Trigger Uri
flowTriggerUri string
Flow Installation Status
installationStatus string
creator
creator UserIdentity
definitionSummary
definitionSummary DefinitionSummary

AdminFlowWithConnectionReferences

Name Path Type Description
Flow Name
name string
properties
properties AdminFlowWithConnectionReferencesProperties

AdminFlowWithConnectionReferencesProperties

Name Path Type Description
Flow Display Name
displayName string
Flow State
state string
connectionReferences
connectionReferences ConnectionReferencesArray
Flow Created Time
createdTime date-time
Flow Modified Time
lastModifiedTime date-time
Flow Template Name
templateName string
Flow Trigger Uri
flowTriggerUri string
Flow Installation Status
installationStatus string
creator
creator UserIdentity
definitionSummary
definitionSummary DefinitionSummary

DefinitionSummary

Name Path Type Description
triggers
triggers array of object
Flow trigger type
triggers.type string
Flow trigger kind
triggers.kind string
actions
actions array of object
Action type
actions.type string
Swagger operation Id
actions.swaggerOperationId string
Action Api name
actions.api.name string
Action Api id
actions.api.id string
Action Api type
actions.api.type string

UserIdentity

Name Path Type Description
Creator tenant ID
tenantId string
Creator object ID
objectId string
Creator user ID
userId string
Creator user type
userType string

Environment

Name Path Type Description
Environment Name
name string
Environment Location
location string
properties
properties EnvironmentProperties

EnvironmentProperties

Name Path Type Description
Environment Display Name
displayName string
Environment Description
description string
Environment Created Time
createdTime date-time
Environment Last Modified Time
lastModifiedTime date-time
Environment Provisioning State
provisioningState string
Environment Creation Type
creationType string
Environment Sku
environmentSku string
Environment Type
environmentType string
Is Default Environment
isDefault boolean

ConnectionReferencesArray

Name Path Type Description
Items
ConnectionReference

ConnectionReferencesDictionary

ConnectionReference

Name Path Type Description
Connection Name
connectionName string
Connection Display Name
displayName string
Connector Id
id string
apiDefinition
apiDefinition ApiWithoutConnectionParameters

ApiWithoutConnectionParameters

Name Path Type Description
Connector Name
name string
properties
properties ApiPropertiesWithoutConnectionParameters

ApiPropertiesWithoutConnectionParameters

Name Path Type Description
Connector Display Name
displayName string
Connection Created Time
createdTime date-time
Connector Runtime Url
primaryRuntimeUrl string
Connector Icon Url
iconUri string
Connector is Custom Api
isCustomApi boolean
Connector Tier
tier string

ConnectionWithoutConnectionParameters

Name Path Type Description
Connection Name
name string
properties
properties ConnectionPropertiesWithoutConnectionParameters

ConnectionPropertiesWithoutConnectionParameters

Name Path Type Description
Connector Display Name
displayName string
Connector Id
apiId string
Connection Created Time
createdTime date-time
Connection Last Modified Time
lastModifiedTime date-time