Search local user

Searches for local users and returns user information.

This topic includes the following sections:

Request
Response
Status codes and messages
Related topic

Request

HTTP method: POST

URL: https://<HOST>:<PORT>/rsso/config/local/user/search

Header: For header information, such as required authentication token, see Remedy-SSO-administrator-Login-and-Logout-calls.

Request body properties

Properties	Type	Required	Description	Values	Default value
searchText	String	No	The text passed as the searchText will be matched against LoginName, userName, and Description for each user and return users with the specified string in any of those fields and who meet the other search criteria. Search is case sensitive. You can pass a partial search value enclosed in % to search for all users with LoginName, username, or Description having the partial search value in those fields. Examples: BMC matches the exact string against all 3 field values %BMC% matches the partial string "BMC" against all 3 field values (such as "BMCadmin") If you do not provide a search value, all users meeting enabled criteria are returned.	User-provided value	NA
enabled	Boolean	No	The user status If you do not provide an enabled value, all users meeting text search criteria are returned.	User-provided value	NA
pageSize	Integer	No	The number of user records to be listed per page -1 means list all users	User-provided value	-1
pageStart	Integer	No	The starting page number for the search results	User-provided value	0
pageNumber	Integer	No	The total number of pages the search results should contain	User-provided value	0

Example request JSON

{
"searchText" : "",
"pageSize" : "-1",
"pageStart" : "0",
"pageNumber" : "0",
"enabled" : ""
}

Response

If successful, this method returns local users.

Response body properties

Property	Description
code	Status code (see Status codes and messages)
msg	Status
data	List of users that match the submitted query

Example response JSON

{
"code":200,
"msg":"OK",
"data":[{"id":0,"loginName":"BMC User","userName":"BMC Atrium Orchestrator","description":"BMC Atrium Orchestrator","enabled":true}]
}

Status codes and messages

For more details about HTTP response codes, see HTTP response codes.

HTTP code	Message (msg)	Description
200	OK	Request succeeded
400		Bad request Some causes are All of the mandatory fields were not specified The input JSON is not valid
401		Unauthorized