API - Map, Un-map User with User Group

Purpose

A post API to map or un-map to the user from or to a group.

Accessing the API

XML

Endpoint: /API/APP/APP007/UserGroupAction

HTTP METHOD

XML

POST

Parameters

Parameters	Data Type	Required	Description
GroupName	String	YES	User Group Name
UserName	String	YES	User Name
Action	String	YES	(map/unmap)
Instance	String	YES	Instance Name

Sample Request (JSON)

XML

{
	"GroupName":"GroupName",
	"UserName":"UserName",
	"Action":"map",
	"Instance":"Instance"
}

Sample Response (JSON)

XML

{
	“Version”:”6.0.0.0”,
	"IsSuccess":true,
	"LogCode":"0",
	"Result":"user XXXXXXX mapped to group (XXXXXXX)",
	"StatusCode":"Accepted",
	"Timestamp":"03 Jun 2019 11:34:45 GMT 05:30:00"
}

Standard Error Response Codes

Error Code	Error Description
011649	Current user lacks permission to perform this action
011651	The authorization header is either empty or not basic
011673	Invalid credentials
011674	Invalid credentials
011675	Unable to validate request
011683	Invalid instance name
011803	Unable to insert API log details
032407	Unable to map user with group
011694	Unable to get user group
011805	Unable to get user group
011813	Unable to map user with group