EnterpriseUser

Service Information:

Version: 1.1

Availability: Production

Release Date: Unknown

Framework: AITS Web Services

Description: Query NetID@Domain listing for a single, known NetID@Domain. Also returns university ID number (UIN).

Source System: Enterprise Authentication Service (EAS)

Operations:

 GET /xfunctionalWS/query/edu.uillinois.moa.jmsobjects.person.v1_1.EnterpriseUser/{senderAppId}/{principal}/{domain}?format={format}

A table detailing the parameter set for a Directory Data GET request.
Parameter Description Type Required
senderAppId
 Identifier of the sender application, e.g. "authorized.app.id"
 String
Yes
principal NetID (case sensitive - requires lower case)
 String Yes
domain University domain (e.g. uis.edu; uic.edu; illinois.edu) NOTE: case sensitive - requires lower case
 String Yes
format Response format ("xml" or "json")
 String No

Sample Request

GET /xfunctionalWS/query/edu.uillinois.moa.jmsobjects.person.v1_1.EnterpriseUser/authorized.app.id/jdoe/illinois.edu?format=json HTTP/1.1
Host: webservices-dev.admin.uillinois.edu

Sample Response

{
  "QueryRequestResult": [
    {
      "EnterpriseUser": {
        "NetId": [
          {
            "Principal": "jdoe",
            "Domain": "illinois.edu"
          },
          {
            "Principal": "jdoe",
            "Domain": "uillinois.edu"
          },
          {
            "Principal": "jdoe",
            "Domain": "uiuc.edu"
          }
        ],
        "LightweightPerson": {
          "Name": {
            "LastName": "Doe",
            "FirstName": "Jane"
          },
          "InstitutionalId": "987654321"
        }
      }
    }
  ]
}

Data Object Detail:

Functional Area: Person

Name: EntperpriseUser

Version: 1.1

Element Map:

A table detailing the attributes and elements within the Directory Data object
Path Type Name Occurrence Description
QueryRequestResult
 Object/Array QueryRequestResult
 Exactly One
 Response container.
EnterpriseUser Object/Array EnterpriseUser Zero or One Root object containing EnterpriseUser data.
EnterpriseUser.NetId
 Object/Array NetId Exactly One
 Child object containing NetID data.
EnterpriseUser.NetId.Principal
 Element pidm Zero or One University Network ID (NetID)
EnterpriseUser.NetId.Domain
 Element uin Zero or One University domain (e.g. illinois.edu, uic.edu, uis.edu)
EnterpriseUser.LightweightPerson
 Element lastName Zero or One Child object containing person data
EnterpriseUser.LightweightPerson.Name
 Element firstName Zero or One Child object containing name data
EnterpriseUser.LightweightPerson.Name.LastName
 Element middleName Zero or One Last Name
EnterpriseUser.LightweightPerson.Name.FirstName Element
 preferredFirstName
 Zero or One
 First Name
EnterpriseUser.LightweightPerson.InstitutionalId
 Element sequenceNum Zero or One Person's University ID number (UIN) [9-character alphanumeric string. The first character will always be a 6 for a person. The remaining characters will be unique numeric combination that identifies the person.]