Search for a Role

This API is used to search for a role based on the input filter condition. A role is a logical entity to group one or more Access Control Functions. The response could be one or more resource(s) matching the input.

Before you begin

  • Session ID is obtained from the login API.
  • Ensure that the session ID is valid and has not expired.
  • Make sure you have valid filter value for search.

Request Structure

Endpoint: /role-search
Type: POST
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/role-search?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
Payload

String

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

Payload

Name Description
filterValue

String

 (Optional) Input filter string value to filter the role.

Example: "admin"
sortColumn

String

 (Optional) Column by which the output has to be sorted.

Example: "name"
sortOrder

String

 (Optional) The order to sort. Possible values are asc and desc.

Example: "asc"

Response Structure

  • Status Code: 200 OK
  • Message: Matching results found for the given input.
  • Headers:
    • Content-Type: application/json
Table 2. Response Parameters
Name Description
response Contains the response attributes for search of role 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 Matching results found for the given input.
404 Not Found DG_009 No matching records found.
400 Bad Request DG_006 Invalid sort Column.
401 Unauthorized AVX_GW_003 Authentication failed, reason - Invalid Credentials.

Sample Request/Response

Use Case

Search a role with the name Role_admin.

Sample Request
https://<IP/HostName/TenantName>:<GWPORT>/avxapi/role-search?gwsource=external
Request Payload
{
  "payload": {
    "filterValue": "Std_API_Account_Search_Role_With_Only_Alphabets",
    "sortColumn": "name",
    "sortOrder": "asc"
  }
}
Sample Response
{
 "response": {
 "data": [
 {
 "name": "admin",
 "description": "admin",
 "permissions": [
 "certificate:connectorActions:secureConnector",
 "certificate:settings:casettings:custom_ca",
 "certificate:settings:appsettings:view",
 "adc:dashboard:deviceheatmap:modifysettings",
 "certificate:client:adminaccess",
 "adc:deviceGroup:delete"
 ],
 "state": "A",
 "accessControlObjects": null,
 "_id": "admin",
 "_keywords": null
 }
 ],
 "totalRecords": 1,
 "obtainedRecords": 1,
 "obtainedRecordRange": {
 "start": 1,
 "end": 1
 }
 },
 "message": "Matching results found for the given input.",
 "appStatusCode": null,
 "tags": null,
 "headers": null
 }
Note: The state of a role indicates if the role is active or not. ‘A’ stands for active.

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.