Page Comparison

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

Summary of People APIs

People API

The centerpiece of the Identity Store People APIs, the People API, is backed by a de-normalized view of 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.

-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

APIs

Additional,

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

a

person

not

available

in

the

de-normalized

view.

• Official

• Name

• Display

• Name

• System

• Ids

• Affiliations

• Contact

• Info

• Primary

• Kerberos

• Account

• Primary

• HSAD

• Account

If

you

need

assistance

with

this

APIs,

please

email

middleware-api@ucdavis.edu.

Application

requirements

Each

request

must

provide

a

valid

application

key.

You

may

sign

up

for

your

own

application

key

here

<INSERT

LINK>.

Using

the

JSON

interface

The

easiest

way

to

start

learning

about

this

interface

is

to

try

it

out.

This

section

shows

how

to

use the curl command line tool to execute sample queries.

NOTE: Details about each API and the available commands are available in separate documents for each individual API

 Attach this curl command to the beginning of any of the below sample requests:

	curl 

{iamid}&key=myKeyv&v=1.0

The

response

to

all

of

the

above

requests

have

a Content-

Type of text/javascript.

 An example

response

for

the

the

following

request

is

shown

below:

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

 ],
  "responseDetails" : null,
  "responseStatus" : 0
}

JSON

reference

Unlike

the

core

JavaScript

interface,

the

JSON

interface

is

exposed

through

a

uniform

URL

that

contains

CGI

arguments.

Your

application

can

use

an

HTTP

stack

of

its

choosing.

In

order

to

use

the

JSON

interface:

• You

• must

• construct

• a

• properly

• formatted

• URL

• with

• all

• necessary

• CGI

• arguments.

• You

• must

• send

• an

• HTTP

• referer

• header

• that

• accurately

• identifies

• your

• application.

• You

• must

• process

• the

• JSON-encoded

• response.

Request

format

URL

base

address

The

base

URL

for

the

IAM

Identity

Store

People

APIs

all

start

with

http://iet-ws.ucdavis.edu/api/people

.

 The details

of

each

API

are

provided

in

documentation

about

each

individual

API.

 (See

links

above)

URL

arguments

This

section

provides

examples

of

the

kinds

of

arguments

that

can

be

used

with

the

People

APIs

The

value

of

a

CGI

argument

must

always

be

properly

escaped.

This

can

be

done

via

the

functional

equivalent

of

JavaScript'

s encodeURIComponent()

 method.

Required

URL

arguments

The

following

table

lists

the

required

URL

arguments.

Search

URL

arguments

The

following

table

lists

the

possible

search

query

URL

arguments.

At

least

one

argument

should

be

provided

to

perform

a

search.

If

multiple

search

criteria

are

provided

an

'AND'

search

will

be

performed

to