principals-delete

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

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`	Integer	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>

Comments

Anhyzer said on Apr 19, 2007 at 12:53 PM :

This isn't a "principal-delete" action at all; it is "principal-disable." It simply add a date to the disabled column in the PPS_PRINCIPALS database. It does not delete the user, the user's content, the user's meeting rooms, and/or the content and archives associated with the user's meeting rooms. I'd love to see a real principal-delete action that does these things.

suzannea said on Apr 19, 2007 at 4:50 PM :

The principals-delete call does not delete the user or content by design.
Once a user is disabled, the content might still be useful.
An account has content and meetings. Some of those may
have been created by the user, but still they belong to the account,
not to the user.

If you do want to delete content, please try sco-delete.

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/04b_acti.htm