Skip to main content

Auth API Overview

The Auth API provides OAuth 2.0, OpenID Connect (OIDC), and token management capabilities for secure authentication and authorization.

Key Features

  • OAuth 2.0 - Client Credentials and Authorization Code flows with PKCE
  • OpenID Connect - Standard OIDC discovery and userinfo endpoints
  • JWT Tokens - Secure token generation and validation
  • JWKS - JSON Web Key Set endpoints for token verification
  • Multi-tenant - Organization-scoped access control

Authentication Flows

Client Credentials Flow

For server-to-server authentication:

Authorization Code Flow with PKCE

For user authentication in web applications:

Quick Example

# Get an access token using client credentials
curl -X POST "https://auth.propper.ai/oauth2/token" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=YOUR_CLIENT_ID" \
-d "client_secret=YOUR_CLIENT_SECRET" \
-d "scope=sign:read sign:write"

Endpoints

EndpointDescription
POST /oauth2/tokenExchange credentials for access tokens
GET /oauth2/authorizeInitiate authorization code flow
GET /.well-known/openid-configurationOIDC discovery document
GET /.well-known/jwks.jsonJSON Web Key Set
GET /oauth2/userinfoGet authenticated user info

Next Steps