Add a Role

This API is used to add a new role to the system.

Before you begin

  • Session ID is obtained from the login API.
  • Ensure that the session ID is valid and has not expired.

Request Structure

Endpoint: /role
Type: POST
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/role?gwkey=f000ca01&gwsource=external

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

Header

 (Mandatory) Use session ID retrieved from login API, if username and password are not provided.

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
Payload

String

 (Mandatory) Input data for request body in application/json format. For payload details, see Payload section.

Payload

Name Description
name

String

 (Mandatory) Name of the role to be added.

Example: "role_1"
description

String

 (Optional) Description of the role to be added.

Example: "Adding a new role"

Response Structure

  • Status Code: 201 Created
  • Message: Role added successfully
  • Headers:
    • Content-Type: application/json
Table 2. Response Parameters
Name Description
response Contains the response attributes for role added 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
201 Created null Role added successfully
409 Conflict ACCT_RO_002 Role name already exists
400 Bad Request VALIDATION_ERROR_0004 'name' should have at least '2' characters, Mandatory Field 'name' is missing or empty.
400 Bad Request ACCT_RO_015 Role name invalid

Sample Request/Response

Use Case

Add a role with a valid role name.

Sample Request
https://<IP/HostName/TenantName>:<GWPORT>/avxapi/role?gwsource=external
Request Payload
{
"payload": {
 "name":"role_01",
 "description":"Adding a new role"
}
}
Sample Response
{ 
"response": "Role added successfully", 
"message": "Role added successfully", 
"appStatusCode": null, 
"tags": null, 
"headers": null 
}

What's Next

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.