Add Service Account

This API is used to create a new service account.

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 login credentials for accessing the system.

Request Structure

Endpoint: /acctmgmt-add-service-account
Type: POST
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/acctmgmt-add-service-account?gwsource=external

To understand the elements of the sample URL, click here.
Headers:
Content-Type: application/json
Authentication: Yes
Request timeout period 15 minutes
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 service account name for authentication. Duplication is not allowed.

Example: "internal90"
email

String

 (Mandatory) Email Address.

Example: "[email protected]"
description

String

 (Optional) Description of the service account.

Example: "description"

Response Structure

  • Status Code: 200 OK
  • Message: Success
  • Headers:
    • Content-Type: application/json
Table 2. Response Parameters
Name Description
response Contains the response attributes for service account added success.
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 Success
409 Conflict ACCT_SA_008 Operation failed. Unable to add new entity. Entity already exists
400 Bad Request ACCT_US_015 Mandatory Field 'email' is missing or empty.
401 Unauthorized AVX_GW_003 Authentication failed, reason - Invalid Credentials.
407 Proxy Authentication Required AVX_GW_011 Session validation failed, reason - Session information is missing.

Sample Request/Response

Use Case

To add a Service account.

Sample Request
https://<IP/HostName/TenantName>:<GWPORT>/avxapi/acctmgmt-add-service-account?gwsource=external
Request Payload
{
"payload": {
    "loginName":"internal90",
    "email": "[email protected]",
    "description":"description"
    }
}
Sample Response
{
    "response": "Success",
    "message": null,
    "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.