Groups - Add Group User

Grants the specified user permissions to the specified workspace.

Notes:

  • Users that have been recently added to a group may not have their new group immediately available, see Refresh user permissions.

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

    POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/users

    URI Parameters

    Name In Required Type Description
    groupId
    path True
    • string
    uuid

    The workspace id

    Request Body

    Name Required Type Description
    displayName
    • string

    Display name of the principal

    emailAddress
    • string

    Email address of the user

    groupUserAccessRight True

    Access rights user has for the workspace

    identifier
    • string

    Identifier of the principal

    principalType

    The principal type

    Responses

    Name Type Description
    200 OK

    OK

    Examples

    example
    example for giving Admin access right to a service principal

    example

    Sample Request

    POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
    {
      "emailAddress": "john@contoso.com",
      "groupUserAccessRight": "Admin"
    }

    Sample Response

    example for giving Admin access right to a service principal

    Sample Request

    POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/users
    {
      "identifier": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
      "groupUserAccessRight": "Admin",
      "principalType": "App"
    }

    Sample Response

    Definitions

    GroupUser

    A Power BI user access right entry for workspace

    GroupUserAccessRight

    Access rights user has for the workspace

    PrincipalType

    The principal type

    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