Identity/Users/SearchForUsers
Returns a collection of users configured for the K2 server
URI
{Service Root URI}/Identity/Users/SearchForUsers?{Query Options}
https://api.denallix.com:443/K2Services/REST.svc/Identity/Users/SearchForUsers?username=DENALLIX%5CBrandon
Method
GET
Query Options
Use wildcard characters to search for partial matches.
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%5C*Brando*"
See http://www.w3schools.com/tags/ref_urlencode.asp for a URL encoding reference.
Starts with: userName=Brando*
https://api.denallix.com:443/K2Services/REST.svc/Identity/Users/SearchForUsers?username=DENALLIX%5CBrando*
Ends with: userName=*randon
https://api.denallix.com:443/K2Services/REST.svc/Identity/Users/SearchForUsers?username=DENALLIX%5C*randon
Contains: userName=*Brandon*
https://api.denallix.com:443/K2Services/REST.svc/Identity/Users/SearchForUsers?username=DENALLIX%5C*Brandon*
Optional
- 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
Return Type
UserCollection or Failure
GET K2Services/REST.svc/Identity/Users/SearchForUsers?username=DENALLIX\Brandon <?xml version="1.0" encoding="utf-8"?> <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>