Share via


Delete a User

 

Applies To: Windows Azure Pack

Deletes a user.

Request

Replace <ServiceMgmt> with your Service Management API endpoint address. . Replace <Port> with either 30005 for the tenant API or 30004 for the administrator API. Replace <name> with the username of the user that is to be deleted.

Method

Request URI

HTTP version

DELETE

https://<ServiceMgmt>:<Port>/users/<name>

HTTP/1.1

URI Parameters

Element name

Description

deleteSubscriptions

True to delete the user, the user’s subscriptions, and the underlying resource.

Force

True to force the deletion of the user, user subscriptions but not its underlying resources.

Request Headers

The following table describes required and optional request headers.

Request header

Description

Authorization: Bearer

Required. Authorization bearer token.

x-ms-principal-id

Required. The principal identifier.

x-ms-client-request-id

Optional. The client request identifier.

x-ms-client-session-id

Optional. The client session identifier.

x-ms-principal-liveid

Optional. The principal Live identifier.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

A successful operation returns status code 202 (ACCEPTED).

For information about status codes, see Status and Error Codes (Windows Azure Pack Service Management).

Response Headers

The response for this operation includes standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Body

None.

Example

The following code example shows a Delete User request.

DELETE https://<Computer>:30004/users/asd@bbb.com?deleteSubscriptions=True&force=False HTTP/1.1
Authorization: Bearer <Token>
x-ms-client-request-id: 502c0502-7c7a-421c-a66c-0c9dfd3b5a26-2013-06-27 21:10:38Z
x-ms-client-session-id: 9ff600b4-0c8b-4110-9eab-4228ce92aa4d
x-ms-principal-id: <COMPUTER>\Administrator
Accept-Language: en-US
x-ms-principal-liveid: <COMPUTER>\Administrator
Host: <Computer>:30004
Content-Length: 0

See Also

Common User Interfaces