/
Find Users

Find Users

Owned by Mark Poidomani
Last updated: Sept 10, 2020 by Odin Soli

WCF


Method
public AuthServerFindUsersResponse FindUsers(string authServerPartnerLoginName, 
                 string authServerPartnerLoginPassword, 
                 string queryFilter,
                 FindUserFilterType  queryType
               )
WCF parameterdata typedescription
authServerPartnerLoginNamestringSurePassID account login name
authServerPartnerLoginPasswordstringSurePassID account login key
queryFilterstringThe filter to be used for searching for users.  The value can user SQL wildcards such as %.
queryFilterTypeFindUserFilterType Identifies the type of queryFilter. Possible values are:  Username or Email. If omitted, Username is assumed
Sample WCF C# Method
AuthServerFindUsersResponse resp = FindUsers("accountLogin",             
            "accountKey", 
            "M%",         // search for all users beginning with M
            FindUserFilterType.LoginName
            );
Sample WCF C# Repsonse
 if (resp.ErrorCode != 0)  {      
       message.Text = resp.ErrorMsg;
       return false;
 }


REST


REST parameterdata typedescription
spAccountLoginNamestringSurePassID account login name
spAccountLoginKeystringSurePassID account login key
typestringfind_users
queryFilterstringThe filter to be used for searching for users.  The value can user SQL wildcards such as %
queryFilterTypestringIdentifies the type of queryFilter. Possible values are:  username or email. If omitted, username is assumed
Sample REST/Json Method
 {  
  "spAccountLoginName": "accountLogin",
  "spAccountLoginKey": "accountKey",
  "queryFilter": "l%",
  "queryFilterType": "username",      // the default if not specified
  "type": "find_users",


}
Sample REST/Json Response
{
  "Users": [
    {
      "username": "larry"
    },
    {
      "username": "loginMarty2"
    },
    {
      "username": "ltest"
    },
    {
      "username": "ltest2"
    },
    {
      "username": "ltest3"
    }
  ],
  "errorCode": 0,
  "errorMessage": "OK",
  "type": "find_users"
}


Related content