Associate User Groups to a 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-updateUsergroups`
Type:	`PUT`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/user-updateUsergroups?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.

Payload


Name	Description
loginName `String`	(Mandatory) Login name of the user. Example: "internal90"
assignUserGroups `Array`	(Optional) An array of user group names to assign. Example: "usergroup_1", "usergroup_2"
unassignUserGroups `Array`	(Optional) An array of user group names to unassign. Example: "usergroup_3"

Note: Even if the assignUserGroups and unAssignUserGroups contain invalid user group names that cannot be processed, the API would still go-ahead to assign/un-assign any user group in the list that can be successfully processed.

Response Structure

Status Code: 200 OK
Message: Successfully modified user-usergroup association.
Headers:
- Content-Type: application/json

Table 2. Response Parameters
Name	Description
response	Contains the response attributes for assigning user group to a user.
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	Successfully modified user-usergroup association.
400 Bad Request	ACCT_US_015	Mandatory Field 'loginName' is missing or empty
400 Bad Request	ACCT_US_56	Assign/Unassign Usergroup list cannot be empty for User

Sample Request/Response

Use Case

"usergroup_1, usergroup_2, and usergroup_3 are existing in the application. usergroup_1 and usergroup_2 have to be assigned to the user with loginname user_1 and usergroup_3 has to be unassigned"

Sample Request

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/user-updateUsergroups?gwsource=external

Request Payload

{
 "payload": {
   "loginName": "appviewx",
   "assignUserGroups": [
     "usergroup_1", "usergroup_2"
   ],
   "unassignUserGroups": [
     "usergroup_3"
   ]
  }
}

Sample Response

{
 "response": "Successfully modified user-user group association",
 "message": " Successfully modified user-user group association ",
 "appStatusCode": null,
 "tags": null,
 "headers": null
 }

What's Next

Search for a User
Add a User

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.