Skip to content

The Nube Auth REST API provides full access to all functionality.

Base URL

Production: https://api.nubeauth.com/v1
Self-hosted: https://your-domain/v1

Authentication

All API requests require authentication via Bearer token:

bash
curl https://api.nubeauth.com/v1/users/me \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

For server-to-server requests, use an API key:

bash
curl https://api.nubeauth.com/v1/admin/users \
  -H "X-API-Key: YOUR_API_KEY"

Response Format

All responses are JSON:

json
{
  "data": { ... },
  "meta": {
    "requestId": "req_abc123"
  }
}

Error responses:

json
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired token",
    "details": { ... }
  },
  "meta": {
    "requestId": "req_abc123"
  }
}

Status Codes

CodeMeaning
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Server Error

Rate Limiting

Default limits:

  • Standard endpoints: 100 requests/minute
  • Auth endpoints: 10 requests/minute
  • Admin endpoints: 1000 requests/minute

Rate limit headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Pagination

List endpoints support pagination:

bash
GET /v1/users?page=1&limit=20

Response includes pagination info:

json
{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

API Endpoints

Authentication

MethodEndpointDescription
POST/auth/loginStart OAuth flow
POST/auth/callbackHandle OAuth callback
POST/auth/magic-linkSend magic link
POST/auth/verifyVerify magic link
POST/auth/refreshRefresh access token
POST/auth/logoutLogout / revoke session

Users

MethodEndpointDescription
GET/users/meGet current user
PATCH/users/meUpdate current user
DELETE/users/meDelete account

Sessions

MethodEndpointDescription
GET/sessionsList user sessions
DELETE/sessions/:idRevoke session
DELETE/sessionsRevoke all sessions

Licenses

MethodEndpointDescription
GET/licenses/meGet current license
GET/licenses/entitlementsCheck entitlements
GET/licenses/usageGet usage stats

See individual API docs for detailed request/response schemas.

Released under the MIT License.