User Identity

All permissions in WebAdMIT cascade from the concept of a user identity.

What is a user identity in WebAdMIT?

Each of the selectable items in the standard WebAdMIT account dropdown are considered to be standard admissions-level user identities. For most universities, this ties to the cohorts of students from each major graduate department:

There are two additional “special” types of identities available in WebAdMIT:

• An “Association User” can access data for all schools in a given Centralized Application Service. (For example, someone at ASPPH would be able to access all data for all schools of public health in SOPHAS, and someone at AACP would be able to access data for all schools of pharmacy in PharmCAS.)
• An “Institution User” can access data for all departments & programs at a university implementing UniCAS. (This type of user would be able to create a university-wide data export.)

In general, configuration entities such as Lists, Exports, Email Templates, and so on in WebAdMIT are “owned” by one of a user’s identities. Every identity that is part of a user’s profile has a name and a unique identifier. These can be retrieved via one of the API calls discussed in this documentation. Admissions, Association, and Institutional identities can all be addressed by name or ID in the same manner.

Attributes

Name	Type	Description	Example
href	string	Hypertext reference to this resource. pattern: /api/v1/user_identities	"/api/v1/user_identities"
user_identities/association	nullable string	Human-readable name of the association that this user identity belongs to, or null if not applicable.	"SOPHAS"
user_identities/cycle	nullable string	Academic cycle that this user identity can access, or null if not applicable. pattern: ^\d{4} - \d{4}$	"2014 - 2015"
user_identities/id	integer	Unique identifier for this user identity.	42
user_identities/institution	nullable string	Human-readable name of the institution that this user identity belongs to, or null if not applicable.	"Demo University"
user_identities/organization	nullable string	Human-readable name of the organization that this user identity belongs to, or null if not applicable.	"Demo University School of Public Health"
user_identities/type	string	Type of access granted by this user identity. one of:"Admissions User" or "Association User" or "Institution User"	"Admissions User"

User Identity List

Retrieve details on all user identities that are part of a user's WebAdMIT profile and that have the "API Access" permission assigned to them. The id associated with each identity will not change, and only becomes something new when a new identity is created – for example at the start of a new academic cycle.

GET /api/v1/user_identities

Curl Example

$ curl -n https://api.webadmit.org/api/v1/user_identities \
  -H "x-api-key: 0123456789abcdef0123456789abcdef"

Response Example

HTTP/1.1 200 OK

{
  "href": "/api/v1/user_identities",
  "user_identities": [
    {
      "id": 42,
      "type": "Admissions User",
      "association": "SOPHAS",
      "institution": "Demo University",
      "organization": "Demo University School of Public Health",
      "cycle": "2014 - 2015"
    }
  ]
}

Unauthorized

Response Example

HTTP/1.1 401 Unauthorized

(Empty response body.)

---