UCSB Campus API Gateway

REST discovered

Details

URL: https://api.ucsb.edu
Docs: https://developer.ucsb.edu/apis/all

Authentication

UCSB API Consumer Key api_key discovered Get key ↗

ucsb-api-key: <credential>

Create a developer-portal account at UCSB API Developer Portal, then sign in and follow Creating Your First App. Create an app, select the APIs it will use, and open the app's Keys section to copy the Consumer Key. This is the API key you send as the ucsb-api-key header. The key only works for APIs on that app that are in Approved status; some APIs are auto-approved and others require a separate access approval process.

UCSB API Consumer Key ucsb-api-key: <credential> + Campus LDAP application or functional account Authorization: Basic <credential> discovered

Campus LDAP application or functional account basic Get credentials ↗

Request a Campus LDAP account using the process on Campus LDAP Accounts (Application vs Functional). Sign in to ETSC, go to Advanced Technical Services > Identity and Access, then choose Create UCSBNetID Functional Account and submit the requested description for either an application account (ou=Applications) or a functional account (ou=People). Use the issued UCSBNetID and password as HTTP Basic credentials for APIs that require backend application identity.

UCSB API Consumer Key ucsb-api-key: <credential> + Campus LDAP application or functional account Authorization: Basic <credential> + Google OAuth end-user JWT for a UCSB Google account ucsb-user-jwt: <credential> discovered

Google OAuth end-user JWT for a UCSB Google account jwt Get key ↗

For APIs that require end-user identity, create Google OAuth credentials using a UCSB Google account (ucsbNetId@ucsb.edu) as described in Security - Google End User OAuth, then follow Google's OAuth 2.0 documentation to obtain a user JWT/ID token for the signed-in end user. UCSB's docs say this token is sent to the API in the ucsb-user-jwt header.