Identity/Users/SearchForUsers

Returns a collection of users, typically used in conjunction with parameters to filter the resulting list.

	Value	Notes
URI	{Service Root URI}/Identity/Users/SearchForUsers?{Query Options} e.g. https://api.denallix.com:443/K2Services/REST.svc/Identity/Users/SearchForUsers?username=DENALLIX%5CBrandon	Use wildcard characters to search for partial matches. Starts with: userName=Brando* (e.g. username=DENALLIX%5CBrando) Ends with: userName=randon (e.g. username=DENALLIX%5Crandon Contains: userName=Brandon* (e.g. username=DENALLIX%5CBrandon) Search strings must be URL encoded. For example, a search for "username=DENALLIX\Brandon" would fail because the backslash character should be URL encoded. The "\" character should be substituted to "username=DENALLIX%5CBrando" See http://www.w3schools.com/tags/ref_urlencode.asp for a URL encoding reference. Optional parameters System Query Options Custom Query Options username (String) = the user name (or part with wildcard) for the users. Example: DENALLIX\Brandon displayName (String) = the display name (or part with wildcard) for the users. Example: Brandon Brown FQN (String) = the fully qualified name (or part with wildcard) for the users. Example: K2:DENALLIX\Brandon manager (String) = the user’s manager user name (or part with wildcard) for the users. Example: DENALLIX\Erica email (String) = the user’s e-mail address. Example: bob@denallix.com
Method	GET
Return Type	UserCollection or Failure
Return Example	<UserCollection xmlns="http://schemas.k2.com/user/d1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <User Username="DENALLIX\Brandon" Fqn="K2:DENALLIX\Brandon" Email="Brandon@denallix.com" Manager="DENALLIX\Erica" DisplayName="Brandon Brown"/> </UserCollection>

Video	Links	Learn	Support
No videos found for this article K2 on YouTube No Additional links found for this article No self-learning content for this article Try some scenarios... No relevant support links available for this article