Using Administrator permissions, delete one or more users or groups (principals).

Availability

Breeze 4

Description

Removes one or more principals, either users or groups. To delete principals, you must have Administrator privilege.

To delete multiple principals, specify multiple principal-id parameters. All of the principals you specify will be deleted.

The principal-id can identify either a user or group. If you specify a user, the user is removed from any groups the user belongs to. If you specify a group, the group is deleted, but the users who belong to it are not.

Request URL

 http://server_name/api/xml 
     ?action=principals-delete 
     &principal-id=integer 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

principal-id

BIGINT

Y

The ID of a user or group you want to delete.

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

 <?xml version="1.0" encoding="utf-8" ?>  
 <results>  
     <status code=allowedValue />  
 </results>

Response values

Element

Attribute

Type

Description

results

Container

All results the action returns.

status

Empty, with attributes

The status of the response.

code

Allowed value

A code indicating the response status (see status).

Sample request

 https://example.com/api/xml?action=principals-delete 
         &principal-id=2006339311&principal-id=2006339323

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results>  
     <status code="ok" />  
 </results>

See also

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy