Assign User group to Service Account

Before you begin


Endpoint:	`/platform-assign-usergroup-to-service-account`
Type:	`PUT`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/platform-assign-usergroup-to-service-account?gwsource=web` 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.


Name	Description
loginName `String`	(Mandatory) Unique names used as the service account name for authentication. Duplication is not allowed. Example: "internal90"
assignedUserGroup `Array`	(Optional) Mention the array of user groups to be assigned. Example: "admin usergroup" Type: String
unassignedUserGroup `Array`	(Optional) Mention the array of user groups to be unassigned. Example: "[ ]"

Table 2. Response Parameters
Name	Description
response	Contains the response attributes for create a new resource.
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.


HTTP Code	appStatusCode	Response Message
201 OK	null	Success
400 Bad Request	ACCT_SA_003	Service account is invalid/not found.
404 Not Found	ACCT_USERGROUP_027	UserGroup not found.

Use Case

To assign/unassign user groups to service account.

Sample Request

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/platform-assign-usergroup-to-service-account?gwsource=web

Request Payload

{
"payload": {
    "loginName": "internal90",
    "assignedUserGroup": [
        "admin usergroup"
    ],
    "unassignedUserGroup": []
   }
}

Sample Response

{
"response": "success",
"message": null,
"appStatusCode": null,
"tags": null,
"headers": null
}

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.