Update User Group Description

This API is used to update the existing user group descriptions.

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-update-usergroup
Type: PUT
Sample URL: https://<Tenant_name/Host_name>:<portno>/avxapi/acctmgmt-update-usergroup?gwkey=f000ca01&gwsource=external
Headers:
Content-Type: application/json
Table 1. Input Parameters
Name Description
sessionID

Header

 (Mandatory) Use session ID retrieved from login API is required if username and password are not provided.

Example: "sessionId": "ce7f1a14-2bf9-4e4a-89a8-bc780a255813"
username

Header

 (Mandatory) AppViewX login username is required if sessionId is not provided.

Example: "admin"
Password

Header

 (Mandatory) AppViewX login password is required if sessionId is not provided..

Example: "AppViewX@123"
Content-Type

Header

 (Mandatory) The parameter should be set to application/json to specify the nature of the data in the payload.

Example: "application/json"
gwkey

Query

 (Optional) Tenant Key. Needed only in the case of multi-tenant installations which is a string value.
gwsource

Query

 (Mandatory) Source from which the request is triggered.
The values can be:
  • web
  • external
name

Payload

String

 (Mandatory) Name of the resource whose description needs to be updated.

Example: "myGroup"
description

Payload

String

 (Mandatory) Description that needs to be updated.

Example: "Sample usergroup for test"

Response Structure

  • Status Code: 200 OK
  • Message: null.
  • Headers:
    • Content-Type: application/json
Table 2. Response Parameters
Name Description
response Contains the response attributes for search of role 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
200 OK null null
400 Bad request ACCT_USERGROUP_001 Invalid usergroup name.
400 Bad request ACCT_USERGROUP_025 Invalid description.
407 Proxy Authentication Required AVX_GW_011 Session validation failed, reason - Session information is missing.

Sample Request/Response

Use Case

To update the existing user group descriptions.

Sample Request
https://<Tenant_name/Host_name>:<portno>/avxapi/acctmgmt-update-usergroup?gwkey=f000ca01&gwsource=external
Request Payload
{name: "myGroup", description: "Sample usergroup for test"}
Sample Response
{
  "response": null,
  "message": null,
  "appStatusCode": null,
  "tags": null,
  "headers": null
}