Remove Allowed Principals

Before you begin

Before attempting to search principals for the host, make sure that the host has been provisioned with a cert based access request so that the principals are available for the host.

Request Structure


Endpoint:	`/ssh/host/principal/remove`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/host/principal/remove?gwsource=external` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Request Parameters
Name	Description
sessionId `Header`	(Mandatory) Session ID received after login. Type: String Constraints: Required if username and password are not provided.
username `Header`	(Mandatory) AppViewX login username. Type: String Constraints: Required if sessionId is not provided.
password `Header`	(Mandatory) AppViewX login password. Type: String Constraints: Required if sessionId is not provided.
Content-Type `Header`	(Mandatory) Specifies the nature of the data in the payload. Type: String Constraints: The value of the param should be ‘application/json’.
gwsource `Query`	(Mandatory) Source from which the request is triggered. (E.g. external) Type: String
Payload `Body`	(Mandatory) Contains all the parameters to be sent in the request body for the post request. Type: Payload

Payload


Name	Description
users	(Mandatory) List of users for whom principal need to be removed. Type: List
deviceName	(Mandatory) Name of device from which principal has to be removed. Type: String
comment	(Optional) Reason for principal removal Type: String

Response Structure

200 OK returns string of type application/json with the following body params.

Table 2. Response Parameters
Name	Description
response	Contains the response message of the API. Type: String
message	Success message of the action or failure description in case of error. Will be non-null for failure response. Type: String
appStatusCode	Application-specific status code for the response. Will be non-null for failure response. Type: String
tags	More info in case of failure response.

Response Structure

200 OK returns string of type application/json with the following body params.

Table 3. Response Parameters
Name	Description
response	Contains the response message for principal removal action.
message	Success message of the action or failure description in case of error. Will be non-null for failure response Type: String
appStatusCode	Application-specific status code for the response. Will be non-null for failure response Type: String
tags	More info in case of failure response

Status Codes

Table 4. Status Codes and Description
HTTP Status code	appStatusCode	Message and Possible remediation
200 OK	NA	Principal removal action has been triggered.
401 Unauthorized	AVX_GW_003	Authentication failed, reason - Invalid Credentials Possible remediation: Ensure that valid username and password or valid sessionId is provided as the header param.
400 Bad Request	VALIDATION_ERROR_0004	Mandatory field <<field name>> is missing or or empty Possible remediation: Check and ensure that valid value is provided for <<field name>> field in the request.
404 Not Found	ERR-SSH-NB-252	SSH device not found. Possible remediation: Check and ensure that deviceName specified in the input refers to a device that exists in the SSH Host Inventory.
400 Bad Request	ERR-SSH_NB-293	Device not in successfully managed status. Action not allowed. Possible remediation: Check and ensure that deviceName specified in the input refers to a device that exists in the SSH Host Inventory.

Sample Request/Response

Use Case

To removed the allowed principals using /host/principal/remove API.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/ssh/host/principal/remove?gwsource=external

Sample Request


{
 "users":["admin"],
 "deviceName":"TestServer1",
 "comment":"Check"
}

Sample Response


{
    "response": "Principal removal action has been triggered",
    "message": null,
    "appStatusCode": null,
    "tags": {},
    "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.
Note: GWPORT is not required for SaaS setups.
Example: 31443
avxapi: Path parameter value (static) that is part of the endpoint's URL
Endpoint: Endpoint of the API, for example: /ssh/host/create
gwsource: Source or origin of a gateway, for example: external.

What's Next

Fetch Allowed Principals