Nexfs Management API Documentation

Method Index

DeleteRole

Delete an existing Managment or Content (S3) Role using the Nexfs Management API

Action: DeleteRole

Delete an existing Role

Permissions

To delete a managment role a requesting session must have the iam/DeleteManagementRoles role enabled.

To delete a user content (s3) role a requesting session must have the nexfs/DeleteContentRoles role enabled.

Request Parameters

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

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

Action

DeleteRole

RoleName

The name of the existing Role to Delete

RoleType

The type of the existing Role to Delete, either "iam" or "user"

Set to "iam" for a management role, or "user" for a user content (s3) role

Version

The version of the Role to be deleted Delete

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>

<DeleteRoleResponse>

<RoleId>integer</RoleId>

<RoleType>string</RoleType>

<ResponseMetadata>

<RequestId>integer</RequestId>

</ResponseMetadata>

</DeleteRoleResponse>

<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

DeleteRoleResponse

Start of the Delete Role Response

RoleId

The Role ID that was deleted

RoleType

The type of role that was deleted (iam or user)

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 generally if either RoleName or Version is missing from the request

400 InvalidInput The Request Input was Invalid

No role exists with a name and version thats matches the request

401 Unauthorized The request cannot be authenticated

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

Example Request

GET http://nexfs.example.com:9200/nexfsconsoleapi?Action=DeleteRole&RoleName=Example%20Role%20Update&RoleType=iam&Version=08/29/2022.1

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: 20220829T141452Z

Example Response

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

</ResponseMetadata>

</DeleteRoleResponse>

<Resource>/nexfsconsoleapi</Resource>

</RequestCompleted>