Nexfs Management API Documentation

Method Index

DeleteUser

Delete an existing User using the Nexfs Management API


Action: DeleteUser

Delete an existing User

Permissions

To delete a user the requesting session must have the iam/UpdateUsers role enabled.

Request Parameters

A request must be made against the nexfs management console api with the DeleteUser action.

The request must be signed with a valid AWS V4 style Signature using an active temporary session security token.

Action

DeleteUser


UserId

The UserID of the User to be deleted


Request Body

The request does not have a request body.

Response Syntax

HTTP1/1 200

<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>string</Code>

<DeleteUserResponse>

<ResponseMetadata>

<RequestId>integer</RequestId>

</ResponseMetadata>

</DeleteUserResponse>

<Resource>string</Resource>

</RequestCompleted>


Response Elements

If the action is successful, the service sends back an HTTP 200 response.


The following data is returned in XML format by the service.

RequestCompleted

Root Level tag for the successful response


Code

OK


DeleteUserResponse

Start of the Delete Role Response


Resource

/nexfsconsoleapi

RequestId

A requestid number that identifies the request made against the management api

Errors

Also See Rest Error Responses


400 BadRequest The request was Malformed

A BadRequest is returned if UserID is missing from the request


401 Unauthorized The request cannot be authenticated


403 Forbidden Session does not have the rights to perform the requested action


409 NoSuchEntity No user exists with the request userid


Example Request

GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=DeleteUser&UserId=exampleuser

Authorization: AAWS4-HMAC-SHA256 Credential=479828c41a304ce496c58e3e7eb146df/20220829/nexfs/nexfsconsoleapi/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=691fa24902920105fcb5e29996d5c74c0c821de6fbfe76b0b2cd12ff94c9a0e9

content-type: application/x-www-form-urlencoded; charset=utf-8

host: nexfs.example.com

x-amz-date: 20220907T124234Z

Example Response


<?xml version="1.0" encoding="UTF-8"?>

<RequestCompleted>

<Code>Ok</Code>

<DeleteUserRoleResponse>

<ResponseMetadata>

<RequestId>501</RequestId>

</ResponseMetadata>

</DeleteUserRoleResponse>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>