Menu
POST change-password/ User API

API endpoint for password change. POST /api/change-password/

Body is validated by PasswordChangeSerializer; its fields are not listed here.

URL

  • User APIhttps://auth.mattering.io/api/change-password/

Responses

200 bare JSON object (no envelope)

{
  "message": "Password changed successfully"
}

400 bare JSON object (no envelope)

[
  "..."
]

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X POST "https://auth.mattering.io/api/change-password/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.PasswordChangeView)

GET generate-login-token/ User API

API endpoint for generating one-time login tokens. GET /api/generate-login-token/

Body is validated by OneTimeTokenSerializer; its fields are not listed here.

URL

  • User APIhttps://auth.mattering.io/api/generate-login-token/

Responses

200 bare JSON object (no envelope)

{
  "token": "...",
  "target_product": "...",
  "expires_in": 60
}

400 bare JSON object (no envelope)

[
  "..."
]

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://auth.mattering.io/api/generate-login-token/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.OneTimeTokenView)

GET jwks/ User API No auth required

API endpoint for JSON Web Key Set. GET /api/jwks/

URL

  • User APIhttps://auth.mattering.io/api/jwks/

Responses

200 bare JSON object (no envelope)

...

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://auth.mattering.io/api/jwks/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.JWKSView)

POST login/ User API No auth required

API endpoint for user login. POST /api/login/

Body is validated by LoginSerializer; its fields are not listed here.

URL

  • User APIhttps://auth.mattering.io/api/login/

Responses

200 bare JSON object (no envelope)

{
  "access_token": "...",
  "refresh_token": "...",
  "token_type": "...",
  "expires_in": "...",
  "scope": "...",
  "user": {
    "...": "..."
  }
}

400 bare JSON object (no envelope)

[
  "..."
]

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X POST "https://auth.mattering.io/api/login/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.LoginView)

POST logout/ User API

API endpoint for user logout. POST /api/logout/

URL

  • User APIhttps://auth.mattering.io/api/logout/

Responses

200 bare JSON object (no envelope)

{
  "message": "Successfully logged out"
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X POST "https://auth.mattering.io/api/logout/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.LogoutView)

GET mfa/enable/ User API

API endpoint for enabling MFA. GET /api/mfa/enable/

URL

  • User APIhttps://auth.mattering.io/api/mfa/enable/

Responses

200 bare JSON object (no envelope)

{
  "secret": "...",
  "qr_code_url": "...",
  "manual_entry_key": "..."
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://auth.mattering.io/api/mfa/enable/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.MFAEnableView)

POST mfa/verify/ User API

API endpoint for MFA verification. POST /api/mfa/verify/

Body is validated by MFAVerifySerializer; its fields are not listed here.

URL

  • User APIhttps://auth.mattering.io/api/mfa/verify/

Responses

200 bare JSON object (no envelope)

{
  "message": "MFA enabled successfully"
}

400 bare JSON object (no envelope)

[
  "..."
]

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400Invalid token message
400MFA device not found message

Example

curl -X POST "https://auth.mattering.io/api/mfa/verify/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.MFAVerifyView)

GETPUT profile/ User API

API endpoint for user profile management. GET /api/profile/ PUT /api/profile/

Body is validated by UserSerializer; its fields are not listed here.

URL

  • User APIhttps://auth.mattering.io/api/profile/

Responses

200 bare JSON object (no envelope)

{
  "...": "..."
}

200 bare JSON object (no envelope)

{
  "organizations": [
    "..."
  ],
  "display_timezone": "...",
  "id": "...",
  "email": "...",
  "username": "...",
  "first_name": "...",
  "last_name": "...",
  "email_verified": "...",
  "is_mfa_enabled": true,
  "last_active": "...",
  "timezone": "...",
  "timezone_auto": "...",
  "detected_timezone": "..."
}

400 bare JSON object (no envelope)

[
  "..."
]

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
500Error retrieving user profile message

Example

curl -X GET "https://auth.mattering.io/api/profile/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.UserProfileView)

POST refresh/ User API No auth required

API endpoint for token refresh. POST /api/refresh/

Body is validated by TokenRefreshSerializer; its fields are not listed here.

URL

  • User APIhttps://auth.mattering.io/api/refresh/

Responses

200 bare JSON object (no envelope)

...

400 bare JSON object (no envelope)

[
  "..."
]

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401Invalid refresh token message

Example

curl -X POST "https://auth.mattering.io/api/refresh/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.TokenRefreshView)

POST register/ User API No auth required

API endpoint for user registration. POST /api/register/

Body is validated by UserRegistrationSerializer; its fields are not listed here.

URL

  • User APIhttps://auth.mattering.io/api/register/

Responses

201 bare JSON object (no envelope)

{
  "message": "User registered successfully",
  "user": {
    "...": "..."
  }
}

400 bare JSON object (no envelope)

[
  "..."
]

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X POST "https://auth.mattering.io/api/register/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN"

Source: mattering_auth/views.py (views.UserRegistrationView)

POST validate-bearer-key/ Service tier

Token introspection for org API keys.

Request:  POST /api/internal/validate-bearer-key/
          Body: {"key": "mat_..."}
Success (200):
    {"valid": true, "sub": "<user_id>", "org_id": "<uuid>",
     "app_slug": "<slug>", "org_name": "<name>"}
Failure (200 with valid=false, or 400):
    {"valid": false, "error": "..."}

Protected by InternalAPIGuard middleware (X-Internal-Secret).

URL

  • Service tierhttps://auth.mattering.io/api/internal/validate-bearer-key/

Body keys (JSON)

KeyRequiredDefault
keyoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 bare JSON object (no envelope)

{
  "valid": true,
  "sub": "...",
  "email": "...",
  "org_id": "...",
  "app_slug": "...",
  "org_name": "...",
  "key_name": "..."
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400Invalid API key message
400Invalid JSON body message
400Key has expired message
400Missing or invalid key format message
400Organization is scheduled for deletion message

Example

curl -X POST "https://auth.mattering.io/api/internal/validate-bearer-key/" \
  -H "X-Internal-Secret: $MATTERING_INTERNAL_API_SECRET" \
  -H "X-Internal-Org-Id: $ORG_ID" \
  -H "X-Internal-User-Email: you@example.com" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "..."
}'

Source: mattering_auth/api_key_views.py (api_key_views.validate_bearer_key)

POST validate/ User API No auth required

API endpoint for token validation. POST /api/validate/

Body is validated by TokenValidationSerializer; its fields are not listed here.

URL

  • User APIhttps://auth.mattering.io/api/validate/

Body keys (JSON)

KeyRequiredDefault
target_productoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 bare JSON object (no envelope)

{
  "valid": true,
  "user": {
    "...": "..."
  },
  "payload": {
    "access_token": "...",
    "refresh_token": "...",
    "token_type": "...",
    "expires_in": "...",
    "scope": "..."
  }
}

400 bare JSON object (no envelope)

[
  "..."
]

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
401Invalid or expired token message
401User not found message

Example

curl -X POST "https://auth.mattering.io/api/validate/" \
  -H "Authorization: Bearer $MATTERING_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "target_product": "..."
}'

Source: mattering_auth/views.py (views.TokenValidationView)

All Auth resources
Start Free Explore our Products