Admin - Groups DeleteUserAsAdmin

  • Reference
Service:
Power BI REST APIs
API Version:
v1.0

Removes user permissions from the specified workspace.

This API call supports removing a user, security group, M365 group and service principal.Please use email address or UPN for user, group object Id for group and app object Id for service principal to delete.

Permissions

The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator).

Required Scope

Tenant.ReadWrite.All

Limitations

Maximum 200 requests per hour. 

DELETE https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/users/{user}
With optional parameters: 
DELETE https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/users/{user}?profileId={profileId}&isGroup={isGroup}

URI Parameters

Name In Required Type Description
groupId
 path True

string

uuid

The workspace ID.
user
 path True

string

The user principal name (UPN) of the user or group object Id of the group or app object Id of the service principal to delete.
isGroup
 query

boolean

Whether a given user is a group or not. This parameter is required when user to delete is group.
profileId
 query

string

uuid

The service principal profile ID to delete.

Responses

Name Type Description
200 OK

OK

Examples

Delete group example
Delete guest user example
Delete service principal example
Delete user example

Delete group example

Sample Request

DELETE https://api.powerbi.com/v1.0/myorg/admin/groups/f7d76f5a-7190-43c6-bf12-7a135c6c2d23/users/23476f5a-7190-43c6-bf12-7a135c6c2d23?isGroup=True

Sample Response

Status code:
200

Delete guest user example

Sample Request

DELETE https://api.powerbi.com/v1.0/myorg/admin/groups/f7d76f5a-7190-43c6-bf12-7a135c6c2d23/users/john_contoso.com%23EXT%23@test.com

Sample Response

Status code:
200

Delete service principal example

Sample Request

DELETE https://api.powerbi.com/v1.0/myorg/admin/groups/f7d76f5a-7190-43c6-bf12-7a135c6c2d23/users/23476f5a-7190-43c6-bf12-7a135c6c2d23

Sample Response

Status code:
200

Delete user example

Sample Request

DELETE https://api.powerbi.com/v1.0/myorg/admin/groups/f7d76f5a-7190-43c6-bf12-7a135c6c2d69/users/john@contoso.com

Sample Response

Status code:
200