Get Role Information

Before you begin

Ensure that the session ID is valid and has not expired.
Make sure you have valid role name to get its information.

Request Structure


Endpoint:	`/role`
Type:	`GET`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/role?roleName=role_1;gwsource=external` 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. Type: String Example: "role_1"

Response Structure

Status Code: 200 OK
Message: Role Information Retrieved Successfully.
Headers:
- Content-Type: application/json

Table 2. **Response Parameters**
Name	Description
response	Contains the response attributes for role information retrieved 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 Information Retrieved Successfully.
404 Not Found	ACCT_RO_001	Role(s) not found.
400 Bad request	ACCT_RO_015	Mandatory field 'roleName' is missing or empty

Sample Request/Response

Use Case

Get the information about the role role_1.

Sample Request

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/role?roleName=role_1;gwsource=external

Request Payload

NA

Sample Response

{
 "response": {
 "name": "role_1",
 "description": "role_1 details",
 "permissions": [
 "permission_1"
 ],
 "state": "A",
 "_id": "log",
 "_keywords": [
 "role used to test role functions.",
 "log",
 "Enabled"
 ]
 },
 "message": "Role Information Retrieved Successfully",
 "appStatusCode": null,
 "tags": 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.