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

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

Group

A Power BI group

Name Type Description
capacityId
  • string

The capacity id

dataflowStorageId
  • string

The Power BI dataflow storage account id

description
  • string

The group description

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

state
  • string

The group state

type
  • string

The type of group

users

The users that belong to the group, and their access rights.

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