Groups - Create Group

Creates new workspace.

Required scope: Workspace.ReadWrite.All
To set the permissions scope, see Register an app.

POST https://api.powerbi.com/v1.0/myorg/groups
POST https://api.powerbi.com/v1.0/myorg/groups?workspaceV2={workspaceV2}

URI Parameters

Name In Required Type Description
workspaceV2
query
  • boolean

Preview feature: Create a workspace V2. The only supported value is true.

Request Body

Name Required Type Description
name True
  • string

The name of the newly created group

Responses

Name Type Description
200 OK

OK

Examples

example
example creating a workspace V2

example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups
{
  "name": "sample group"
}

Sample Response

{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    }
  ]
}

example creating a workspace V2

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups?workspaceV2=True
{
  "name": "sample workspace V2"
}

Sample Response

{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isOnDedicatedCapacity": false,
      "name": "sample workspace V2"
    }
  ]
}

Definitions

Dashboard

A Power BI dashboard

Dataflow

The metadata of a dataflow

Dataset

A Power BI dataset

Encryption

Encryption information for a dataset

EncryptionStatus

Dataset encryption status

Group

A Power BI group

GroupCreationRequest

Power BI create a new group request

GroupUser

A Power BI user access right entry for workspace

GroupUserAccessRight

Access rights user has for the workspace

PrincipalType

The principal type

Report

A Power BI report

Dashboard

A Power BI dashboard

Name Type Description
displayName
  • string

The dashboard display name

embedUrl
  • string

The dashboard embed url

id
  • string

The dashboard id

isReadOnly
  • boolean

Is ReadOnly dashboard

Dataflow

The metadata of a dataflow

Name Type Description
configuredBy
  • string

The dataflow owner

description
  • string

The dataflow description

modelUrl
  • string

A URL to the dataflow definition file (model.json)

name
  • string

The dataflow name

objectId
  • string

The dataflow id

Dataset

A Power BI dataset

Name Type Description
Encryption

The dataset encryption information (Only applicable when $expand is specified)

IsEffectiveIdentityRequired
  • boolean

Dataset requires effective identity

IsEffectiveIdentityRolesRequired
  • boolean

Dataset requires roles

IsOnPremGatewayRequired
  • boolean

Dataset requires an On-premises Data Gateway

IsRefreshable
  • boolean

Can this dataset be refreshed

addRowsAPIEnabled
  • boolean

Whether dataset allows adding new rows

configuredBy
  • string

The dataset owner

id
  • string

The dataset id

name
  • string

The dataset name

webUrl
  • string

The dataset web url

Encryption

Encryption information for a dataset

Name Type Description
EncryptionStatus

Dataset encryption status

EncryptionStatus

Dataset encryption status

Name Type Description
InSyncWithWorkspace
  • string

Encryption is supported and is in sync with the encryption settings

NotInSyncWithWorkspace
  • string

Encryption is supported and not in sync with the encryption settings

NotSupported
  • string

Encryption is not supported for this dataset

Unknown
  • string

Unable to determine state due to dataset corruption

Group

A Power BI group

Name Type Description
capacityId
  • string

The capacity id

dashboards

The dashboards that belong to the group. Available only for admin API calls.

dataflowStorageId
  • string

The Power BI dataflow storage account id

dataflows

The dataflows that belong to the group. Available only for admin API calls.

datasets

The datasets that belong to the group. Available only for admin API calls.

description
  • string

The group description. Available only for admin API calls.

id
  • string

The workspace id

isOnDedicatedCapacity
  • boolean

Is the group on dedicated capacity

isReadOnly
  • boolean

Is the group read only

name
  • string

The group name

reports

The reports that belong to the group. Available only for admin API calls.

state
  • string

The group state. Available only for admin API calls.

type
  • string

The type of group. Available only for admin API calls.

users

The users that belong to the group, and their access rights. Available only for admin API calls.

GroupCreationRequest

Power BI create a new group request

Name Type Description
name
  • string

The name of the newly created group

GroupUser

A Power BI user access right entry for workspace

Name Type Description
displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

groupUserAccessRight

Access rights user has for the workspace

identifier
  • string

Identifier of the principal

principalType

The principal type

GroupUserAccessRight

Access rights user has for the workspace

Name Type Description
Admin
  • string

Grants administrator rights to workspace

Contributor
  • string

Grants read and write access to content in group

Member
  • string

Grants read access to content in workspace

None
  • string

Removes permission to content in workspace

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

User
  • string

User principal type

Report

A Power BI report

Name Type Description
datasetId
  • string

The dataset id

embedUrl
  • string

The report embed url

id
  • string

The report id

name
  • string

The report name

webUrl
  • string

The report web url