Get User Rule Objects

This URL gets the user rule objects. If the filter string is provided, all the users matching to the given filter string will be returned. If more than one user matches the specified filter, maximum number of users will be restricted by max_entries_expected filter specified in the URL.

Resource URL

GET /ruleobject/user?filter=<user_name_filter>&maxcount=<max_entries_expected>

Request Parameters

Field Name	Description	Data Type	Mandatory
`user_name_filter`	User filter string	String	No
`max_entries_expected`	Maximum users to be displayed if more than 1 user match the user filter string	Number	No

Response Parameters

Following fields are returned if the request parameters are correct, otherwise error details are returned.

Field Name	Description	Data Type
`UserRuleObjectResponseList`	List of user rule object	Array

Details of object in UserRuleObjectResponseList:

Field Name	Description	Data Type
`ruleObjectId`	Rule object id	String
`ruleObjectName`	Rule object name	String
`ruleObjectType`	Rule object type	String

Example

Request

GET https://<NSM_IP>/sdkapi/ruleobject/user?filter=user&max_count=10

Response

{
       "userRuleObjectResponseList":
       [
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-3491",
               "ruleObjectName": "user_32@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-1177",
               "ruleObjectName": "user_48@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-1123",
               "ruleObjectName": "DFServ_user1@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-1200",
               "ruleObjectName": "user_71@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-3601",
               "ruleObjectName": "myuser_15@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-3430",
               "ruleObjectName": "user_103@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-3560",
               "ruleObjectName": "user_88_2@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-3562",
               "ruleObjectName": "user_88_4@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-3479",
               "ruleObjectName": "user_20@rltest.com",
               "ruleObjectType": "User"
           },
           {
               "ruleObjectId": "S-1-5-21-1459593717-2655996711-1404495803-1188",
               "ruleObjectName": "user_59@rltest.com",
               "ruleObjectType": "User"
           }
       ]
}

Error Information

Following error codes are returned by this URL:

S.No	HTTP Error Code	SDK API errorId	SDK API errorMessage
1	500	1001	internal error