Add a User

This API is used to create a new user.

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: /user
Type: POST
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/user?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
loginName

String

 (Mandatory) Unique names used as the username for authentication. Duplication is not allowed.

Example: "appviewx"
password

String

 (Mandatory) A password that can be used to authenticate. It must be in the base64 encoded format.
Note: Not relevant if ‘isExternalAuth’ is set to Y.

Example: "QWRtaW5AMTIz"
confirmPassword

String

 (Mandatory) Reconfirm the given password. It must be in the base64 encoded format.
Note: Not relevant if ‘isExternalAuth’ is set to Y.

Example: "QWRtaW5AMTIz"
isExternalAuth

String

 (Mandatory) Specify if the user is from an external authentication system like LDAP, Radius, etc. Possible values are ‘Y’ for yes and ‘N’ for No.

Example: "N"
comment

String

 (Optional) Comment for the user.

Example: "This is a test user"
preferredContactMode

String

 (Mandatory) Preferred contact mode. Possible values are ‘E’ for email.

Example: "E"
email

String

 (Mandatory) Email address.

Example: "[email protected]"

Response Structure

  • Status Code: 201 Created
  • Message: User added successfully.
  • Headers:
    • Content-Type: application/json
Table 2. Response Parameters
Name Description
response Contains the response attributes for user 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 User added successfully.
401 Unauthorized AVX_GW_003 Authentication failed, reason - Invalid Credentials.
409 Conflict ACCT_US_042 User name already exist.
400 Bad Request ACCT_US_015 Mandatory field 'loginName' is missing or empty.

Sample Request/Response

Use Case

Add a new internal user with login name appviewx.

Sample Request
https://<IP/HostName/TenantName>:<GWPORT>/avxapi/user?gwsource=external
Request Payload
{
 "payload": {
 "loginName": "appviewx",
 "password":"QWRtaW5AMTIz",
 "confirmPassword": "QWRtaW5AMTIz",
 "isExternalAuth" : "N",
 "comment": "This is a test user",
 "preferredContactMode": "E",
 "email": "[email protected]"
 }
 }
Sample Response
{
 "response": "User added successfully",
 "message": "User 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.