iam-rosetta-api

Rosetta - UC Davis IAM API

Authentication and Use

Rosetta uses Oauth 2.0 for authentication.

Scopes are required for accessing endpoints as well as data.

Oauth clients can be requested via the Oauth Provider

Documentation and available scopes can be found in the Security section of this API Spec

Examples of Common Actions

REST Endpoints:

###############################################

Get Person Information by IAM ID

Method: GET

https://rosetta.api.ucdavis.edu/api/v1/people?iamid=1000479142

###############################################

Get Person Information by Email

Method: GET

https://rosetta.api.ucdavis.edu/api/v1/people?email=wamiller@ucdavis.edu

###############################################

Get Person Information for all Students who are also Campus Employees

Method: GET

https://rosetta.api.ucdavis.edu/api/v1/people?affiliationContains=student&employmentStatus=is_campus_employee

###############################################

GraphQL:

Endpoint:

https://rosetta.api.ucdavis.edu/api/v1/graphql

###############################################

Return Selected Person Information for People with the Same Manager

Method: POST

Body (TEXT):

query {
    people(filter: {manager_iam_id: "1000303595"}) {
      results{
        iam_id
        displayname
        manager_iam_id
      }
    }
}

###############################################

Return Selected Person Information a subset of students while also getting the total count of all students

Method: POST

Note: count must be set to true in order for x_total_count and the response header 'X-Total-Count' to be populated

Body(JSON):

{
  "query": "query {
    people(filter: {limit: 50, affiliationContains: \"student\", count: true}) {
      results {
        iam_id name { lived_first_name lived_last_name }
        id { login_id }
        email { primary work personal }
        phone { primary work personal }
        student_association { college major academic_level class_level }
        }
      meta {
        x_total_count
      }

    }
  }"
}