Power Platform for Admins (Preview)

Power Platform Management Connector for Admins

This connector is available in the following products and regions:

Service Class Regions
Power Automate Standard All Power Automate regions except the following:
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   China Cloud operated by 21Vianet
Connector Metadata
Publisher Microsoft
Website https://admin.powerplatform.microsoft.com/

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Create CDS Database

Creates a new CDS instance in the specified Environment.

Create Environment

Creates a new Environment.

Create Environment DLP Policy

Creates an Environment DLP Policy.

Create Tenant DLP Policy

Creates a new Tenant DLP Policy.

Delete Environment

Deletes an Environment.

Delete Environment DLP Policy

Deletes an Environment DLP Policy.

Delete Tenant DLP Policy

Deletes a Tenant DLP Policy.

Edit Environment Role Assignment

Sets permissions for an Environment.

Force Sync user

Used to sync PowerApps user to CRM.

Get CDS Provisioning Status

Used to check the status of a provisioning operation.

Get Environment as Admin

Returns a single Environment as Admin.

Get Environment DLP Policy

Returns an Environment DLP Policy.

Get Environment Operation Status

Used to check the status of an environment operation, sucn as deletion.

Get Tenant DLP Policy

Returns a Tenant DLP Policy.

List DLP Policies

Returns a list of all Tenant and Environment DLP Policies.

List Environment Role Assignments

Returns a list of permissions for an Environment without CDS for Apps.

List Environments as Admin

Returns a list of Environments.

List Supported Environment Currencies

Returns a list of supported Currencies based on the location.

List Supported Environment Languages

Returns a list of supported Languages based on the location.

List Supported Locations

Returns a list of Locations where BAP service is supported.

Update Environment DLP Policy

Updates an Environment DLP Policy.

Update Tenant DLP Policy

Updates the fields in a DLP Policy.

Validate Environment Delete

Used to check if an Environment can be deleted.

Create CDS Database

Creates a new CDS instance in the specified Environment.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

Base language
baseLanguage integer

Any language returned from List Environment Languages.

Currency code
code string

Any currency code returned from List Environment Currencies.

Templates
Templates string

Name of the Environment.

Returns

Environment object.

Create Environment

Creates a new Environment.

Parameters

Name Key Required Type Description
Location
location True string

Region the Environment is deployed in.

Display Name
displayName True string

Vanity name of the Environment.

Environment Sku
environmentSku True string

Type of Environment.

Returns

Environment object.

Create Environment DLP Policy

Creates an Environment DLP Policy.

Parameters

Name Key Required Type Description
API Version
api-version string

The date value of the API.

Environment
environment True string

Name of the Environment.

Display Name
displayName True string

Api Policy display name.

Schema Version
$schema True string

Api Policy definition $schema.

Name
name True string

Policy Environment name field.

ID
id True string

Policy Environment ID field.

Type
type True string

Policy Environment type field.

Business Data description
description string

Policy business data group description.

Connector ID
id string

Business Data connector ID field.

Connector Name
name string

Business Data connector name field.

Connector Type
type string

Business Data connector type field.

Non Business Data description
description string

Policy non business data group description.

Connector ID
id string

Non Business Data connector ID field.

Connector Name
name string

Non Business Data connector name field.

Connector Type
type string

Non Business Data connector type field.

Default Group
defaultApiGroup True string

Group a new connector is automatically added to.

Block Action Type
type True string

Block action type, leave blank if adding a block is not desired.

Returns

Body
Policy

Create Tenant DLP Policy

Creates a new Tenant DLP Policy.

Parameters

Name Key Required Type Description
API Version
api-version string

The date value of the API.

Display Name
displayName True string

Api Policy display name.

Schema Version
$schema True string

Api Policy definition $schema.

Constraint Type
type True string

Policy constraint type, leave blank to apply policy to all Environments.

Name
name True string

Policy Environment name field.

ID
id True string

Policy Environment ID field.

Type
type True string

Policy Environment type field.

Environment Filter Type
filterType True string

Api Policy constraint environmentFilter1 parameter filterType.

Business Data description
description string

Policy business data group description.

Connector ID
id string

Business Data connector ID field.

Connector Name
name string

Business Data connector name field.

Connector Type
type string

Business Data connector type field.

Non Business Data description
description string

Policy non business data group description.

Connector ID
id string

Non Business Data connector ID field.

Connector Name
name string

Non Business Data connector name field.

Connector Type
type string

Non Business Data connector type field.

Default Group
defaultApiGroup True string

Group a new connector is automatically added to.

Block Action Type
type True string

Block action type, leave blank if adding a block is not desired.

Returns

Body
Policy

Delete Environment

Deletes an Environment.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

API Version
api-version string

The date value of the API.

Returns

Environment object.

Delete Environment DLP Policy

Deletes an Environment DLP Policy.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

Policy
policy True string

The name field of the Policy.

API Version
api-version string

The date value of the API.

Returns

response
object

Delete Tenant DLP Policy

Deletes a Tenant DLP Policy.

Parameters

Name Key Required Type Description
Policy
policy True string

The name field of the Policy.

API Version
api-version string

The date value of the API.

Returns

response
object

Edit Environment Role Assignment

Sets permissions for an Environment.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

API Version
api-version string

The date value of the API.

Principal Email
email string

The principal email of the user.

Principal Tenant ID
tenantId string

The principal tenant ID of the user.

Principal Object ID
id string

The principal object ID of the user.

Principal Type
type string

The principal type of the user.

Role Definition ID
id string

The role definition ID. Format: /providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/{environment}/{roleName}.

id
id string

The id field.

Returns

Force Sync user

Used to sync PowerApps user to CRM.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

ObjectId
ObjectId True string

User object Id.

Get CDS Provisioning Status

Used to check the status of a provisioning operation.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

Operation
operationName True string

Name of the Operation.

API Version
api-version string

The date value of the API.

Get Environment as Admin

Returns a single Environment as Admin.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

API Version
api-version string

The date value of the API.

Returns

Environment object.

Get Environment DLP Policy

Returns an Environment DLP Policy.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

Policy
policy True string

The name field of the Policy.

API Version
api-version string

The date value of the API.

Returns

Body
Policy

Get Environment Operation Status

Used to check the status of an environment operation, sucn as deletion.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

Operation
operationName True string

Name of the Operation.

API Version
api-version string

The date value of the API.

Get Tenant DLP Policy

Returns a Tenant DLP Policy.

Parameters

Name Key Required Type Description
Policy
policy True string

The name field of the Policy.

API Version
api-version string

The date value of the API.

Returns

Body
Policy

List DLP Policies

Returns a list of all Tenant and Environment DLP Policies.

Parameters

Name Key Required Type Description
API Version
api-version string

The date value of the API.

Returns

List Environment Role Assignments

Returns a list of permissions for an Environment without CDS for Apps.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

API Version
api-version string

The date value of the API.

Returns

List Environments as Admin

Returns a list of Environments.

Parameters

Name Key Required Type Description
API Version
api-version string

The date value of the API.

Skip Token
$skiptoken string

The input used to get the next page of the response.

Page size
$top integer

Number of Environments in the response.

Returns

List Supported Environment Currencies

Returns a list of supported Currencies based on the location.

Parameters

Name Key Required Type Description
Location
environmentLocation True string

The location of the Environment.

API Version
api-version string

The date value of the API.

Returns

Body
Currencies

List Supported Environment Languages

Returns a list of supported Languages based on the location.

Parameters

Name Key Required Type Description
Location
environmentLocation True string

The location of the Environment.

API Version
api-version string

The date value of the API.

Returns

Body
Languages

List Supported Locations

Returns a list of Locations where BAP service is supported.

Parameters

Name Key Required Type Description
API Version
api-version string

The date value of the API.

Returns

Body
Locations

Update Environment DLP Policy

Updates an Environment DLP Policy.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

Policy
policy True string

The name field of the Policy.

API Version
api-version string

The date value of the API.

Display Name
displayName True string

Api Policy display name.

Schema Version
$schema True string

Api Policy definition $schema.

Name
name True string

Policy Environment name field.

ID
id True string

Policy Environment ID field.

Type
type True string

Policy Environment type field.

Business Data description
description string

Policy business data group description.

Connector ID
id string

Business Data connector ID field.

Connector Name
name string

Business Data connector name field.

Connector Type
type string

Business Data connector type field.

Non Business Data description
description string

Policy non business data group description.

Connector ID
id string

Non Business Data connector ID field.

Connector Name
name string

Non Business Data connector name field.

Connector Type
type string

Non Business Data connector type field.

Default Group
defaultApiGroup True string

Group a new connector is automatically added to.

Block Action Type
type True string

Block action type, leave blank if adding a block is not desired.

Returns

Body
Policy

Update Tenant DLP Policy

Updates the fields in a DLP Policy.

Parameters

Name Key Required Type Description
Policy
policy True string

The name field of the Policy.

API Version
api-version string

The date value of the API.

Display Name
displayName True string

Api Policy display name.

Schema Version
$schema True string

Api Policy definition $schema.

Constraint Type
type True string

Policy constraint type, leave blank to apply policy to all Environments.

Name
name True string

Policy Environment name field.

ID
id True string

Policy Environment ID field.

Type
type True string

Policy Environment type field.

Environment Filter Type
filterType True string

Api Policy constraint environmentFilter1 parameter filterType.

Business Data description
description string

Policy business data group description.

Connector ID
id string

Business Data connector ID field.

Connector Name
name string

Business Data connector name field.

Connector Type
type string

Business Data connector type field.

Non Business Data description
description string

Policy non business data group description.

Connector ID
id string

Non Business Data connector ID field.

Connector Name
name string

Non Business Data connector name field.

Connector Type
type string

Non Business Data connector type field.

Default Group
defaultApiGroup True string

Group a new connector is automatically added to.

Block Action Type
type True string

Block action type, leave blank if adding a block is not desired.

Returns

Body
Policy

Validate Environment Delete

Used to check if an Environment can be deleted.

Parameters

Name Key Required Type Description
Environment
environment True string

Name of the Environment.

API Version
api-version string

The date value of the API.

Returns

Definitions

ResourceArray[Policy]

Name Path Type Description
value
value array of Policy

Policy

Name Path Type Description
Policy ID
id string

Policy ID field.

Policy Type
type string

Policy type field.

Policy Name
name string

Policy name field.

Display Name
properties.displayName string

Api Policy display name.

Created time
properties.createdTime date-time

Api Policy created time.

Created by
properties.createdBy Principal[CreatedBy]

Policy created by principal object.

Modified time
properties.lastModifiedTime date-time

Api Policy modified time.

Modified by
properties.lastModifiedBy Principal[ModifiedBy]

Policy modified by principal object.

Schema Version
properties.definition.$schema PolicySchema

Api Policy definition $schema.

Type
properties.definition.constraints.environmentFilter1.type string

Policy environmentFilter type.

Environments
properties.definition.constraints.environmentFilter1.parameters.environments PolicyEnvironments

Policy Environment.

Filter Type
properties.definition.constraints.environmentFilter1.parameters.filterType string

Api Policy constraint environmentFilter1 parameter filterType.

apiGroups
properties.definition.apiGroups PolicyApiGroups
Default Group
properties.definition.defaultApiGroup PolicyDefaultApiGroup

Group a new connector is automatically added to.

rules
properties.definition.rules PolicyRules

Policy rules object.

ResourceArray[Environment]

Name Path Type Description
value
value array of Environment

Environment value object array.

Next Link
nextLink string

The URL to get the next page of the Environments list.

Environment

Environment object.

Name Path Type Description
ID
id string

Environment ID field.

Type
type string

Environment type field.

Name
name string

Environment name field.

Location
location string

Environment location field.

Azure Region Hint
properties.azureRegionHint string

Environment azureRegionHint field.

Display Name
properties.displayName string

Display Name of Environment.

Created Time
properties.createdTime date-time

Created Time of Environment.

Created by
properties.createdBy Principal[CreatedBy]

Policy created by principal object.

lastModifiedTime
properties.lastModifiedTime date-time

Environment lastModified date and time.

Modified by
properties.lastModifiedBy Principal[ModifiedBy]

Policy modified by principal object.

Provisioning State
properties.provisioningState string

Environment provisioningState.

Creation Type
properties.creationType string

Creation Type of Environment.

Environment Sku
properties.environmentSku string

Sku ID of Environment.

Environment Type
properties.environmentType string

Type of Environment.

Is Default
properties.isDefault boolean

Is Default Environment or not.

Business App Platform
properties.runtimeEndpoints.microsoft.BusinessAppPlatform string

BusinessAppPlatform runtime endpoint.

Common Data Model
properties.runtimeEndpoints.microsoft.CommonDataModel string

CommonDataModel runtime endpoint.

PowerApps
properties.runtimeEndpoints.microsoft.PowerApps string

PowerApps runtime endpoint.

Flow
properties.runtimeEndpoints.microsoft.Flow string

Flow runtime endpoint.

Soft Deleted Time
properties.softDeletedTime date-time

Environment softDeletedTime.

Type
properties.linkedEnvironmentMetadata.type string

Environment linkedEnvironmentMetadata type.

Resource Id
properties.linkedEnvironmentMetadata.resourceId string

Environment linkedEnvironmentMetadata resourceId.

Friendly Name
properties.linkedEnvironmentMetadata.friendlyName string

Environment linkedEnvironmentMetadata friendlyName.

Unique Name
properties.linkedEnvironmentMetadata.uniqueName string

Environment linkedEnvironmentMetadata uniqueName.

Domain Name
properties.linkedEnvironmentMetadata.domainName string

Environment linkedEnvironmentMetadata domainName.

Version
properties.linkedEnvironmentMetadata.version string

Environment linkedEnvironmentMetadata version.

Instance URL
properties.linkedEnvironmentMetadata.instanceUrl string

Environment linkedEnvironmentMetadata instanceUrl.

Instance API URL
properties.linkedEnvironmentMetadata.instanceApiUrl string

Environment linkedEnvironmentMetadata instanceApiUrl.

Base Language
properties.linkedEnvironmentMetadata.baseLanguage integer

Environment linkedEnvironmentMetadata baseLanguage.

Instance State
properties.linkedEnvironmentMetadata.instanceState string

Environment linkedEnvironmentMetadata instanceState.

Created Time
properties.linkedEnvironmentMetadata.createdTime date-time

Environment linkedEnvironmentMetadata createdTime.

Modified Time
properties.linkedEnvironmentMetadata.modifiedTime date-time

Environment linkedEnvironmentMetadata modifiedTime.

Host Name Suffix
properties.linkedEnvironmentMetadata.hostNameSuffix string

Environment linkedEnvironmentMetadata hostNameSuffix.

BAP Solution Id
properties.linkedEnvironmentMetadata.bapSolutionId string

Environment linkedEnvironmentMetadata bapSolutionId.

Creation Templates
properties.linkedEnvironmentMetadata.creationTemplates array of string

Environment linkedEnvironmentMetadata creationTemplates.

Management Package Version
properties.linkedEnvironmentMetadata.managementPackageVersion string

Environment linkedEnvironmentMetadata managementPackageVersion.

PolicyEnvironments

Policy Environment.

Name Path Type Description
Name
name string

Policy Environment name field.

ID
id string

Policy Environment ID field.

Type
type string

Policy Environment type field.

PolicyRules

Policy rules object.

Name Path Type Description
Block Action Type
apiGroupRule.actions.blockAction.type string

Block action type, leave blank if adding a block is not desired.

PolicySchema

Api Policy definition $schema.

Api Policy definition $schema.

Schema Version
string

PolicyApiGroups

Name Path Type Description
hbi
hbi PolicyHbi

Policy Hbi group.

lbi
lbi PolicyLbi

PolicyHbi

Policy Hbi group.

Name Path Type Description
Business Data description
description string

Policy business data group description.

Business Data
apis array of object

Business Data APIs.

Connector ID
apis.id string

Business Data connector ID field.

Connector Name
apis.name string

Business Data connector name field.

Connector Type
apis.type string

Business Data connector type field.

PolicyLbi

Name Path Type Description
Non Business Data description
description string

Policy non business data group description.

Non Business Data
apis array of object

Non Business Data APIs.

Connector ID
apis.id string

Non Business Data connector ID field.

Connector Name
apis.name string

Non Business Data connector name field.

Connector Type
apis.type string

Non Business Data connector type field.

PolicyDefaultApiGroup

Group a new connector is automatically added to.

Group a new connector is automatically added to.

Default Group
string

ValidateDeleteResponse

Name Path Type Description
Can Delete
canInitiateDelete boolean

Environment can be deleted.

Errors array
errors array of object

Errors array

Code
errors.error.code string

Error code for validate delete.

Message
errors.error.message string

Error message.

resourcesToBeDeleted
resourcesToBeDeleted array of object
ID
resourcesToBeDeleted.id string

Resource to be deleted ID.

Name
resourcesToBeDeleted.name string

Resource to be deleted name.

Type
resourcesToBeDeleted.type string

Resource to be deleted type.

ResourceArray[RoleAssignment]

Name Path Type Description
value
value array of object

Environment Role Assignment value object array.

id
value.id string

Environment Role Assignment ID field.

type
value.type string

Environment Role Assignment type field.

name
value.name string

Environment Role Assignment field name.

scope
value.properties.scope string

Environment Role Assignment scope.

id
value.properties.roleDefinition.id string

Environment Role Assignment roleDefinition ID field.

type
value.properties.roleDefinition.type string

Environment Role Assignment roleDefinition type field.

name
value.properties.roleDefinition.name string

Environment Role Assignment roleDefinition field name.

id
value.properties.principal.id string

Environment Role Assignment principal object ID.

displayName
value.properties.principal.displayName string

Environment Role Assignment principal displayName.

email
value.properties.principal.email string

Environment Role Assignment principal email.

type
value.properties.principal.type string

Environment Role Assignment principal type.

RoleAssignment

Name Path Type Description
add
add array of object

Environment Role Assignment add object.

id
add.roleAssignment.id string

Environment Role Assignment roleAssignment ID field.

type
add.roleAssignment.type string

Environment Role Assignment roleAssignment type field.

name
add.roleAssignment.name string

Environment Role Assignment roleAssignment name field.

scope
add.roleAssignment.properties.scope string

Environment Role Assignment scope.

id
add.roleAssignment.properties.roleDefinition.id string

Environment Role Assignment roleDefinition ID field.

type
add.roleAssignment.properties.roleDefinition.type string

Environment Role Assignment roleDefinition ID field.

name
add.roleAssignment.properties.roleDefinition.name string

Environment Role Assignment roleDefinition name field.

id
add.roleAssignment.properties.principal.id string

Environment Role Assignment principal object ID.

displayName
add.roleAssignment.properties.principal.displayName string

Environment Role Assignment principal displayName.

email
add.roleAssignment.properties.principal.email string

Environment Role Assignment principal email.

type
add.roleAssignment.properties.principal.type string

Environment Role Assignment principal type.

httpStatus
add.httpStatus string

Environment Role Assignment httpStatus.

Principal[ModifiedBy]

Policy modified by principal object.

Name Path Type Description
ID
id string

Modified by principal object ID.

Display name
displayName string

Modified by principal displayName.

Email
email string

Modified by principal.

Type
type string

Modified by principal type.

Tenant ID
tenantId string

Modified by principal tenant ID.

UPN
userPrincipalName string

Modified by userPrincipalName.

Principal[CreatedBy]

Policy created by principal object.

Name Path Type Description
ID
id string

Api Policy creator principal object ID.

Display name
displayName string

Api Policy creator principal displayName.

Email
email string

Api Policy creator principal email.

Type
type string

Api Policy creator principal type.

Tenant ID
tenantId string

Api Policy creator principal tenant ID.

UPN
userPrincipalName string

Api Policy creator userPrincipalName.

Locations

Name Path Type Description
value
value array of object
ID
value.id string

Location ID.

Name
value.name string

Location Name.

Display Name
value.properties.displayName string

Location display name.

Is Default
value.properties.isDefault boolean

Is the default location.

Is Disabled
value.properties.isDisabled boolean

Location is Disabled.

Currencies

Name Path Type Description
value
value array of object
ID
value.id string

Currency ID.

Name
value.name string

Currency name.

Locale ID
value.properties.localeId integer

Locale ID of the currency.

Localized Name
value.properties.localizedName string

Localized name of the currency.

Display Name
value.properties.displayName string

Currency display name.

Languages

Name Path Type Description
value
value array of object
Name
value.name string

Language name field.

ID
value.id string

Language ID field.

Type
value.type string

Language type field.

Locale ID
value.properties.localeId integer

Language locale ID field.

Localized Name
value.properties.localizedName string

Language localized name field.

Display Name
value.properties.displayName string

Language display name field.

Is Tenant Default
value.properties.isTenantDefault boolean

Language is tenant default field.

object

This is the type 'object'.