API - Get Users by Group

Purpose

A post API to get a list of users linked in a specified group.

Accessing the API

XML

Endpoint: /API/APP/APP007/GetUsersByGroup

HTTP METHOD

XML

POST

Parameters

Parameters	Data Type	Required	Description
Filter	String	YES	All/Active/Disabled/Locked/Dormant
Group Name	String	YES	User group name
Instance	String	YES	Instance name

Sample Request (JSON)

XML

{
	"Filter":"String",
	"GroupName":"Developer",
	"Instance":"Default"
}

Sample Response (JSON)

XML

{
	"Version":"2.3.0.0",
	"IsSuccess": true,
	"LogCode":"0",
	"Result":"{
	"GroupName": "GroupName",
	"Users": [
		{
		  "AuthenticationType": "SectonaAuthentication",
		  "Username": "Username",
		  "FirstName": "FirstName",
		  "LastName": "LastName",
		  "CreatedBy": "CreatedBy",
		  "CreatedOn": "03 Jun 2019 10:55:42 GMT 05:30:00",
		  "Status": "Active"
		},
		{
		  "AuthenticationType": "SectonaAuthentication",
		  "Username": "Username",
		  "FirstName": "FirstName",
		  "LastName": "LastName",
		  "CreatedBy": "CreatedBy",
		  "CreatedOn": "03 Jun 2019 10:55:42 GMT 05:30:00",
		  "Status": "Active"
		}
	  ]
	}",
	"StatusCode":"Accepted",
	"Timestamp":"03 Jun 2019 10:55:42 GMT 05:30:00"
}