Assign User group to Service Account

This API is used to create a new resource. A resource is a logical entity to group one or more ACL managed entities.

URL: avxapi/platform-assign-usergroup-to-service-account?gwkey=f000ca01&gwsource=web

Method - Post

Response Format: JSON

Requires authentication: Yes

Request timeout period:15 minutes

Param Type Name Description Field Type
Header sessionId** (or) Token** Use either Session Id or Token received after login. String
Query assignedUserGroup Mention the array of user groups to be assigned. String
Payload loginName** Unique names used as the service account name for authentication. Duplication is not allowed. String
Payload unassignedUserGroup Mention the array of user groups to be unassigned. String

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
400 Bad request Mandatory field 'name' is missing.
201 Created Resource added successfully.
409 Conflict Resource with the given name already exists.
407 Proxy Authentication Required The Username and Password field is mandatory.

Sample Request/Response

Use Case

To assign/unassign user groups to service account.

Request URL

avxapi/platform-assign-usergroup-to-service-account?gwkey=f000ca01&gwsource=web

Request Payload
 {
"payload": {
"loginName": "internal90",
"assignedUserGroup": [
"admin usergroup"
],
"unassignedUserGroup": [
]
}
}
 
Response
 {
"response": "success",
"message": null,
"appStatusCode": null,
"tags": null,
"headers": null
}