Versions Compared

Old Version 27

changes.mady.by.user Gary Sharpe

Saved on

compared with

New Version Current

changes.mady.by.user Gouthami Narala

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning
titleDRAFT * DRAFT * DRAFT

This documentation is a work in progress and should not be use for production applications.

Section
Column
width20%
Panel
borderColor#BF9900
bgColor#FFFFFF
titleBGColor#E5D699
titleIn this Section
borderStylesolid
Table of Contents
indent15px
stylenone
Column

...

Overview

These 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 APIs

Core People API

The centerpiece of the Identity Store People APIs, the Core People API, provides information about people, including official and display names, affiliations, and system IDs (e.g. mothraId, studentId, etc.). 

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
titleSample JSON Requests
curl -i -H "Accept: application/json"

...

https://iet-ws

...

.ucdavis.edu/api/iam/people/search?

...

oFirstName=Gary&

...

oLastName=Sharpe&key=myKeyv&v=1.0

...

...

The 
...
 specifics 
...
 of 
...
the Core People API, including results, supported search parameters and methods, are included on a separate page here.
Supporting People APIs
Additional, supporting APIs are available to provide access to a subset of the data available in the Core People API, 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.