API - Get User Groups Information

Purpose

A post API to get a list of user groups in Sectona PAM.

Accessing the API

XML

Endpoint: /API/APP/APP007/GetUserGroups

HTTP METHOD

XML

POST

Parameters

Parameters	Data Type	Required	Description
Filter	String	YES	All/Active/Disabled
Instance	String	YES	Instance name

Sample Request (JSON)

XML

{ 
	"Filter":"String",
    "Instance":"String",
}

Sample Response (JSON)

XML

{
	“Version”:”6.0.0.0”,
	"IsSuccess": true,
	"LogCode":"0",
	"Result" : { 
[

     "GroupName":"String",
     "Description":"String",
     "Method":"String",
     "Attributes": {
		 [
			 "Attribute":"String",
			 "Operator":"String ",
			 "Input":"String”
		 ]
	 },
     "ActiveDirectory": {
		 [
			 "DirectoryStore":"String",
			 "UserGroups":"String ",
			 "ExcludeUsers":"String",
			 "ProvisionNewUser":"String",
			 "MapLinkedDirectoryStoreForNewUser":"String”
		]
	 },
     "CreatedBy":"String",
     "CreatedOn":true/false,
     "Status":"String",
     "Instance":"String",
]
},
"StatusCode":"Accepted",
"Timestamp":"03 Jun 2019 10:42:30 GMT 05:30:00"
}

Standard Error Response Codes

Error Code	Error Description
011649	Current users do not have permission to take 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
032404	Unable to get user groups
011808	Unable to get user groups