User API

API change history

List of APIs related to Account Management, User and Group

Search users

Search for the list of users based on the search criteria.

Results :

  1. Only up to 20 records will be returned.

  2. Only users with Staff or TA roles are permitted to search.

Try it

Request

Request URL

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "roles": [
    "string"
  ],
  "listOperations": {
    "sortby": "string",
    "offset": 0,
    "limit": 0,
    "where": "string"
  },
  "filter": "string"
}
{
  "description": "HTTP Post Input class for Users when search",
  "required": [
    "filter"
  ],
  "type": "object",
  "properties": {
    "roles": {
      "description": "Types of User Roles - Staff, Student, Guest",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "listOperations": {
      "description": "Optional parameters for Sorting, paging and filtering",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "sortby": {
              "type": "string"
            },
            "offset": {
              "format": "int32",
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer"
            },
            "limit": {
              "format": "int32",
              "maximum": 10000,
              "minimum": 1,
              "type": "integer"
            },
            "where": {
              "type": "string"
            }
          }
        }
      ]
    },
    "filter": {
      "type": "string"
    }
  }
}
{
  "roles": [
    "string"
  ],
  "listOperations": {
    "sortby": "string",
    "offset": 0,
    "limit": 0,
    "where": "string"
  },
  "filter": "string"
}
{
  "description": "HTTP Post Input class for Users when search",
  "required": [
    "filter"
  ],
  "type": "object",
  "properties": {
    "roles": {
      "description": "Types of User Roles - Staff, Student, Guest",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "listOperations": {
      "description": "Optional parameters for Sorting, paging and filtering",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "sortby": {
              "type": "string"
            },
            "offset": {
              "format": "int32",
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer"
            },
            "limit": {
              "format": "int32",
              "maximum": 10000,
              "minimum": 1,
              "type": "integer"
            },
            "where": {
              "type": "string"
            }
          }
        }
      ]
    },
    "filter": {
      "type": "string"
    }
  }
}
{
  "roles": [
    "string"
  ],
  "listOperations": {
    "sortby": "string",
    "offset": 0,
    "limit": 0,
    "where": "string"
  },
  "filter": "string"
}
{
  "description": "HTTP Post Input class for Users when search",
  "required": [
    "filter"
  ],
  "type": "object",
  "properties": {
    "roles": {
      "description": "Types of User Roles - Staff, Student, Guest",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "listOperations": {
      "description": "Optional parameters for Sorting, paging and filtering",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "sortby": {
              "type": "string"
            },
            "offset": {
              "format": "int32",
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer"
            },
            "limit": {
              "format": "int32",
              "maximum": 10000,
              "minimum": 1,
              "type": "integer"
            },
            "where": {
              "type": "string"
            }
          }
        }
      ]
    },
    "filter": {
      "type": "string"
    }
  }
}
{
  "roles": [
    "string"
  ],
  "listOperations": {
    "sortby": "string",
    "offset": 0,
    "limit": 0,
    "where": "string"
  },
  "filter": "string"
}
{
  "description": "HTTP Post Input class for Users when search",
  "required": [
    "filter"
  ],
  "type": "object",
  "properties": {
    "roles": {
      "description": "Types of User Roles - Staff, Student, Guest",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "listOperations": {
      "description": "Optional parameters for Sorting, paging and filtering",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "sortby": {
              "type": "string"
            },
            "offset": {
              "format": "int32",
              "maximum": 2147483647,
              "minimum": 0,
              "type": "integer"
            },
            "limit": {
              "format": "int32",
              "maximum": 10000,
              "minimum": 1,
              "type": "integer"
            },
            "where": {
              "type": "string"
            }
          }
        }
      ]
    },
    "filter": {
      "type": "string"
    }
  }
}

Responses

200 OK

Returns a list of [API_User.API.Users] subset

Representations

{
  "type": "array",
  "items": {
    "description": "Users class model",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "GUID of the user",
        "type": "string"
      },
      "userID": {
        "description": "User ID",
        "type": "string"
      },
      "loginDomain": {
        "description": "Login Domain\r\nNUSNET domain: ldapstf.nus.edu.sg, ldapstu.nus.edu.sg, ldapext.nus.edu.sg",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "Date which the account is created",
        "type": "string"
      },
      "updatorName": {
        "description": "The name of the user who last updated",
        "type": "string"
      },
      "lastDeletedBy": {
        "format": "uuid",
        "description": "Last deleted by",
        "type": "string"
      },
      "lastDeletedDate": {
        "format": "date-time",
        "description": "Last deleted date",
        "type": "string"
      },
      "userName": {
        "description": "Display name of the user",
        "type": "string"
      },
      "userNameOriginal": {
        "description": "Original name of the user. Sync from Oracle",
        "type": "string"
      },
      "userMatricNo": {
        "description": "Student Number or Staff Number",
        "type": "string"
      },
      "userFaculty": {
        "description": "GUID of the user faculty",
        "type": "string"
      },
      "position": {
        "description": "Position of the user. Applicable for staff only.",
        "type": "string"
      },
      "title": {
        "description": "Title of the user. Applicable for staff and Guest (gst) only.",
        "type": "string"
      },
      "nickName": {
        "description": "Nick name to be displayed",
        "type": "string"
      },
      "phoneNo": {
        "description": "Phone number",
        "type": "string"
      },
      "mobileNo": {
        "description": "Mobile number",
        "type": "string"
      },
      "officialEmail": {
        "description": "Official email address of the user",
        "type": "string",
        "readOnly": true
      },
      "email": {
        "description": "Email address of the user",
        "type": "string"
      },
      "acceptSMS": {
        "description": "True to accept SMS",
        "type": "boolean"
      },
      "matricYear": {
        "description": "Year which the student matriculated. Applicable for student only.",
        "type": "string"
      },
      "displayPhoto": {
        "description": "True to display the photo. Applicable for students only. Staff will display the photo by default. Guest has no photos.",
        "type": "boolean"
      },
      "degreeCode": {
        "description": "Degree code of the student",
        "type": "string"
      },
      "studentType": {
        "description": "Applicable only for students only. Student Type: P = Postgrad students, U = Undergrad students, X = Exchange students",
        "type": "string"
      },
      "aboutMe": {
        "description": "Writeup of the user",
        "type": "string"
      },
      "properties": {
        "description": "Other properties",
        "type": "string"
      },
      "groupIDs": {
        "description": "GroupIDs which the user belongs to",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "userID": "string",
    "loginDomain": "string",
    "createdDate": "string",
    "updatorName": "string",
    "lastDeletedBy": "string",
    "lastDeletedDate": "string",
    "userName": "string",
    "userNameOriginal": "string",
    "userMatricNo": "string",
    "userFaculty": "string",
    "position": "string",
    "title": "string",
    "nickName": "string",
    "phoneNo": "string",
    "mobileNo": "string",
    "officialEmail": "string",
    "email": "string",
    "acceptSMS": true,
    "matricYear": "string",
    "displayPhoto": true,
    "degreeCode": "string",
    "studentType": "string",
    "aboutMe": "string",
    "properties": "string",
    "groupIDs": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "Users class model",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "GUID of the user",
        "type": "string"
      },
      "userID": {
        "description": "User ID",
        "type": "string"
      },
      "loginDomain": {
        "description": "Login Domain\r\nNUSNET domain: ldapstf.nus.edu.sg, ldapstu.nus.edu.sg, ldapext.nus.edu.sg",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "Date which the account is created",
        "type": "string"
      },
      "updatorName": {
        "description": "The name of the user who last updated",
        "type": "string"
      },
      "lastDeletedBy": {
        "format": "uuid",
        "description": "Last deleted by",
        "type": "string"
      },
      "lastDeletedDate": {
        "format": "date-time",
        "description": "Last deleted date",
        "type": "string"
      },
      "userName": {
        "description": "Display name of the user",
        "type": "string"
      },
      "userNameOriginal": {
        "description": "Original name of the user. Sync from Oracle",
        "type": "string"
      },
      "userMatricNo": {
        "description": "Student Number or Staff Number",
        "type": "string"
      },
      "userFaculty": {
        "description": "GUID of the user faculty",
        "type": "string"
      },
      "position": {
        "description": "Position of the user. Applicable for staff only.",
        "type": "string"
      },
      "title": {
        "description": "Title of the user. Applicable for staff and Guest (gst) only.",
        "type": "string"
      },
      "nickName": {
        "description": "Nick name to be displayed",
        "type": "string"
      },
      "phoneNo": {
        "description": "Phone number",
        "type": "string"
      },
      "mobileNo": {
        "description": "Mobile number",
        "type": "string"
      },
      "officialEmail": {
        "description": "Official email address of the user",
        "type": "string",
        "readOnly": true
      },
      "email": {
        "description": "Email address of the user",
        "type": "string"
      },
      "acceptSMS": {
        "description": "True to accept SMS",
        "type": "boolean"
      },
      "matricYear": {
        "description": "Year which the student matriculated. Applicable for student only.",
        "type": "string"
      },
      "displayPhoto": {
        "description": "True to display the photo. Applicable for students only. Staff will display the photo by default. Guest has no photos.",
        "type": "boolean"
      },
      "degreeCode": {
        "description": "Degree code of the student",
        "type": "string"
      },
      "studentType": {
        "description": "Applicable only for students only. Student Type: P = Postgrad students, U = Undergrad students, X = Exchange students",
        "type": "string"
      },
      "aboutMe": {
        "description": "Writeup of the user",
        "type": "string"
      },
      "properties": {
        "description": "Other properties",
        "type": "string"
      },
      "groupIDs": {
        "description": "GroupIDs which the user belongs to",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "userID": "string",
    "loginDomain": "string",
    "createdDate": "string",
    "updatorName": "string",
    "lastDeletedBy": "string",
    "lastDeletedDate": "string",
    "userName": "string",
    "userNameOriginal": "string",
    "userMatricNo": "string",
    "userFaculty": "string",
    "position": "string",
    "title": "string",
    "nickName": "string",
    "phoneNo": "string",
    "mobileNo": "string",
    "officialEmail": "string",
    "email": "string",
    "acceptSMS": true,
    "matricYear": "string",
    "displayPhoto": true,
    "degreeCode": "string",
    "studentType": "string",
    "aboutMe": "string",
    "properties": "string",
    "groupIDs": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "Users class model",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "GUID of the user",
        "type": "string"
      },
      "userID": {
        "description": "User ID",
        "type": "string"
      },
      "loginDomain": {
        "description": "Login Domain\r\nNUSNET domain: ldapstf.nus.edu.sg, ldapstu.nus.edu.sg, ldapext.nus.edu.sg",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "Date which the account is created",
        "type": "string"
      },
      "updatorName": {
        "description": "The name of the user who last updated",
        "type": "string"
      },
      "lastDeletedBy": {
        "format": "uuid",
        "description": "Last deleted by",
        "type": "string"
      },
      "lastDeletedDate": {
        "format": "date-time",
        "description": "Last deleted date",
        "type": "string"
      },
      "userName": {
        "description": "Display name of the user",
        "type": "string"
      },
      "userNameOriginal": {
        "description": "Original name of the user. Sync from Oracle",
        "type": "string"
      },
      "userMatricNo": {
        "description": "Student Number or Staff Number",
        "type": "string"
      },
      "userFaculty": {
        "description": "GUID of the user faculty",
        "type": "string"
      },
      "position": {
        "description": "Position of the user. Applicable for staff only.",
        "type": "string"
      },
      "title": {
        "description": "Title of the user. Applicable for staff and Guest (gst) only.",
        "type": "string"
      },
      "nickName": {
        "description": "Nick name to be displayed",
        "type": "string"
      },
      "phoneNo": {
        "description": "Phone number",
        "type": "string"
      },
      "mobileNo": {
        "description": "Mobile number",
        "type": "string"
      },
      "officialEmail": {
        "description": "Official email address of the user",
        "type": "string",
        "readOnly": true
      },
      "email": {
        "description": "Email address of the user",
        "type": "string"
      },
      "acceptSMS": {
        "description": "True to accept SMS",
        "type": "boolean"
      },
      "matricYear": {
        "description": "Year which the student matriculated. Applicable for student only.",
        "type": "string"
      },
      "displayPhoto": {
        "description": "True to display the photo. Applicable for students only. Staff will display the photo by default. Guest has no photos.",
        "type": "boolean"
      },
      "degreeCode": {
        "description": "Degree code of the student",
        "type": "string"
      },
      "studentType": {
        "description": "Applicable only for students only. Student Type: P = Postgrad students, U = Undergrad students, X = Exchange students",
        "type": "string"
      },
      "aboutMe": {
        "description": "Writeup of the user",
        "type": "string"
      },
      "properties": {
        "description": "Other properties",
        "type": "string"
      },
      "groupIDs": {
        "description": "GroupIDs which the user belongs to",
        "type": "string"
      }
    }
  }
}

400 Bad Request

Bad Request

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

403 Forbidden

Login user not authorized to perform this action

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X POST "https://luminus.azure-api.net/user/Search"
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://luminus.azure-api.net/user/Search?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://luminus.azure-api.net/user/Search");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/user/Search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://luminus.azure-api.net/user/Search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://luminus.azure-api.net/user/Search');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("POST", "/user/Search?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("POST", "/user/Search?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://luminus.azure-api.net/user/Search')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body