Delete a Role

This API is used to delete a role.

Before you begin

  • Ensure that the session ID is valid and has not expired.
  • Make sure you have valid role name to be deleted.

Request Structure

Endpoint: /role
Type: DELETE
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/role?gwsource=External&roleName=role_01

To understand the elements of the sample URL, click here.
Headers:
Content-Type: application/json
Table 1. Input Parameters
Name Description
sessionId (or) Token

Header

 (Mandatory) Use either Session Id or Token received after login.

Type: String

Example: "sessionId": "ce7f1a14-2bf9-4e4a-89a8-bc780a255813"
gwsource

Query

 (Mandatory) Source from which the request is triggered. The values can be:
  • web
  • external

Type: String
roleName

Query

 (Mandatory) Name of the role to delete.

Type: String

Example: "role_01"

Response Structure

  • Status Code: 200 OK
  • Message: Role deleted successfully.
  • Headers:
    • Content-Type: application/json
Table 2. Response Parameters
Name Description
response Contains the response attributes for role deleted successfully.
message Success message or failure description in case of error.
appStatusCode Application specific status code for the response. Will be non-null for failure response.
tags More info in case of failure response.

Status Codes

HTTP Code appStatusCode Response Message
200 OK null Role deleted successfully.
404 Not Found ACCT_RO_001 RoleName doesnot exist.
409 Forbidden NA Role(s) which have active user(s) cannot be deleted.
409 Conflict ACCT_RO_016 Administrative role cannot be deleted
401 Unauthorized AVX_GW_003 Authentication failed, reason - Invalid Credentials.
400 Bad Request ACCT_RO_015 Mandatory field 'roleName' is missing or empty.
400 Bad Request ACCT_RO_032 Pre-shipped role(s) are not eligible for updation/deletion

Sample Request/Response

Use Case

Delete a role with name role_01.

Sample Request
https://<IP/HostName/TenantName>:<GWPORT>/role?gwsource=External&roleName=role_01
Request Payload
NA
Sample Response
{
 "response": "Role deleted successfully",
 "message": "Role deleted successfully",
 "appStatusCode": null,
 "tags": null,
 "headers": null
 }

Reference

Understanding the sample URL:
  • IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
    • IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication

      The IP address will be included in the endpoint URL for an on-prem deployment.

    • HostName: A human-readable label assigned to a device (host) on a network

      The hostname will be included in the endpoint URL for an on-prem deployment.

    • TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify

      The tenant name will be included in the endpoint URL for a SaaS deployment.

  • GWPORT: AppViewX gateway port

    A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.

    Example: 31443

  • avxapi: Path parameter value (static) that is part of the endpoint's URL
  • Endpoint: Endpoint of the API, for example: execute-hook
  • gwsource: Source or origin of a gateway, for example: external.