Purpose
A post API to get a list of users from Sectona PAM.
Accessing the API
XML
Endpoint: /API/APP/APP007/GetUsers
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":[
"AuthenticationType":"String",
"DirectoryStore":"String",
"Username":"String",
"FirstName":"String",
"LastName":"String",
"MobileNo":"String",
"EmailID":"String",
"Tags":"String",
"UserAccessPolicy":"String",
"UserRole":"String",
"UserType":"String",
"Company":"String",
"Department":"String",
"Manager":"String",
"CustomAttribute1":"String",
"CustomAttribute2":"String",
"DevoidSecurity":true/false,
"Expiry":true/false,
"ExpiryDate":"DateTime",
"CreatedBy":"String",
"CreatedOn":"String",
"Status":true/false,
"UserStatus":"String",
"LinkedStaticGroups":"String",
"LinkedNonStaticGroups":"String",
"Instance":"String",
],
"StatusCode":"Accepted",
"Timestamp":"03 Jun 2019 10:47:50 GMT 05:30:00"
}
Standard Error Response Codes
|
Error Code |
Error Description |
|---|---|
|
011649 |
Current user do not have permission to take an 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 |
|
032405 |
Unable to get user |
|
011694 |
Unable to get user group |
|
011807 |
Unable to get user |