Information
- OpenAPI version:
3.0.0
Overview
Northwestern Laravel Starter API 1.0.0
Section titled “Northwestern Laravel Starter API 1.0.0”The API endpoints the Northwestern Laravel Starter ships. Applications add their own beside them.
Authentication
Section titled “Authentication”oauth2
Section titled “oauth2”OAuth 2.0. A service integration uses the client credentials flow with a service client created in Administration, and its token acts as the client’s API user. An application registered in Administration uses the authorization code flow with PKCE, and its token acts as the person who connected it, within the scopes they approved.
Security scheme type: oauth2
Flow type: clientCredentials
Token URL: /oauth/token
Scopes:
- view-users - View everyone's profiles and details.
Flow type: authorizationCode
Authorization URL: /oauth/authorize
Token URL: /oauth/token
Refresh URL: /oauth/token
Scopes:
- view-users - View everyone's profiles and details.
bearerToken
Section titled “bearerToken”A personal access token created on the Account page, or an access token from either OAuth flow, sent as a bearer token in the Authorization header.
Security scheme type: http