OverviewThese APIs provide search capability for People data that is published from the IAM Identity Store. These APIs will return general information about people, including names, system ids, affiliations, primary user accounts, and contact info. Audience| Excerpt |
|---|
This documentation is intended for developers who wish to perform a basic search on the public data within the IAM system from within their application via the REST with JSON interface. |
This is currently the only interface available for this API. If you would like to see an XML interface please email middleware-api@ucdavis.edu.Summary of People APIsPeople APIThe centerpiece of the Identity Store People APIs, the core People API, is backed by a de-normalized view of provides information about people, including official and display names, affiliations, and system IDs (e.g. mothraId, studentId, etc.). The data from this view is exposed through the People API, and is accessible at: https://iet-ws-test.ucdavis.edu/api/iam/people/ Accessing this data is as easy as passing your search parameters as query parameters in the url. For example, the following curl command would return information about the user, Gary Sharpe. | Code Block |
|---|
| title | Sample JSON Requests |
|---|
|
curl -i -H "Accept: application/json" https://iet-ws-test.ucdavis.edu/api/iam/people/search?firstName=Gary&lastName=Sharpe&key=myKeyv&v=1.0
|
The specifics of this API are included on a separate page here. Supporting People APIsAdditional, supporting APIs are available to provide access to a subset of the data available in the de-normalized view, as well as other information about people not available in the core People API. If you need assistance with this APIs, please email middleware-api@ucdavis.edu. Application requirementsEach request must provide a valid application key. You may sign up for your own application key here <INSERT LINK>. |