Indox Auth API - OSLLM AI

Authentication & User Management

POST

/auth/api/v1/login/

Code
 
Unified login endpoint supporting traditional username/email/password, Google OAuth, and Apple Sign-In authentication with unique email constraint. Returns Bearer token with rate limiting.

**Token Expiration (Automatic):**
- Default (remember_me=false): 14 days
- Remember Me (remember_me=true): 30 days

**No manual token refresh needed - tokens are automatically managed based on the remember_me flag.**

Request model for user login. Supports traditional username/password/email, Google OAuth, and Apple Sign-In authentication. For Google OAuth authentication: - Tokens can be provided in request body (legacy method) - Tokens can be read from HTTPOnly cookies (recommended - set automatically after OAuth callback) - If tokens are in cookies, no need to include them in request body For Apple Sign-In authentication: - Tokens can be provided in request body (legacy method) - Tokens can be read from HTTPOnly cookies (recommended - set automatically after OAuth callback) - If tokens are in cookies, no need to include them in request body

Username or email address for traditional login

writeOnly

Email address for traditional login (alternative to username field)

Password for traditional login

writeOnly

Google OAuth access token (from body or cookies)

writeOnly

Google OAuth ID token/JWT (from body or cookies)

writeOnly

Apple identity token/JWT (from body or cookies)

remember_me

boolean

Remember user session for extended period

Default: true

Response model for authentication containing token and user info.

required

object · required

Default: Authentication successful

Default: Bearer

POST/auth/api/v1/login/

import requests

url = "/auth/api/v1/login/"

payload = {
    "password": "string",
    "remember_me": True,
    "username or email": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "password": "string",
  "remember_me": true,
  "username or email": "string"
}

json

Example Responses

{
  "message": "string",
  "token_type": "string",
  "oidc_token": "string",
  "external_token": "string",
  "client_id": "string",
  "audience": "string",
  "services": [
    {}
  ],
  "expires_in": 0,
  "expires_at": "string",
  "refresh_expires_at": "string",
  "user": {},
  "integrations": {}
}

json

application/json

Register endpoint - returns success message with rate limiting. AU 12.2

POST

/auth/api/v1/register/

Register endpoint - returns success message with rate limiting. Accepts username, email, first name, last name, and password in the request body.

Register endpoint - returns success message with rate limiting. AU 12.2 › Request Body

Request model for user registration.

username

string · required

email

string · required

password

string · required

terms_accepted

boolean · required

Default:

Register endpoint - returns success message with rate limiting. AU 12.2 › Responses

Created

Response model for simple message replies.

message

string · required

POST/auth/api/v1/register/

import requests

url = "/auth/api/v1/register/"

payload = {
    "username": "username",
    "email": "email",
    "password": "password",
    "first_name": "string",
    "last_name": "string",
    "terms_accepted": True
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "username": "username",
  "email": "email",
  "password": "password",
  "first_name": "string",
  "last_name": "string",
  "terms_accepted": true
}

json

Example Responses

{
  "message": "message"
}

json

application/json

Set new password endpoint - returns Bearer token with rate limiting. AU 12.3

POST

/auth/api/v1/set-new-password/

Set new password endpoint - returns Bearer token with rate limiting. Accepts password in the request body.

Set new password endpoint - returns Bearer token with rate limiting. AU 12.3 › Request Body

Request model for changing password.

password

string · required

New password to set

Set new password endpoint - returns Bearer token with rate limiting. AU 12.3 › Responses

Response model for authentication containing token and user info.

required

object · required

Default: Authentication successful

Default: Bearer

POST/auth/api/v1/set-new-password/

import requests

url = "/auth/api/v1/set-new-password/"

payload = { "password": "password" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "password": "password"
}

json

Example Responses

{
  "message": "string",
  "token_type": "string",
  "oidc_token": "string",
  "external_token": "string",
  "client_id": "string",
  "audience": "string",
  "services": [
    {}
  ],
  "expires_in": 0,
  "expires_at": "string",
  "refresh_expires_at": "string",
  "user": {},
  "integrations": {}
}

json

application/json

Change or set password endpoint. AU 12.5

POST

/auth/api/v1/change-password/

Change password for authenticated users or set initial password for OAuth users without requiring current password verification.

Change or set password endpoint. AU 12.5 › Request Body

Request model for changing password with current password verification.

current_password

string · required

Current password for verification

new_password

string · required

New password to set

Change or set password endpoint. AU 12.5 › Responses

Response model for simple message replies.

message

string · required

POST/auth/api/v1/change-password/

import requests

url = "/auth/api/v1/change-password/"

payload = {
    "current_password": "current_password",
    "new_password": "new_password"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "current_password": "current_password",
  "new_password": "new_password"
}

json

Example Responses

{
  "message": "message"
}

json

application/json

Resend email confirmation for users who didn't receive their verification email. AU 12.4

POST

/auth/api/v1/resendEmailConfirmation/

Resend email confirmation for users who didn't receive their verification email. Accepts email in the request body.

Resend email confirmation for users who didn't receive their verification email. AU 12.4 › Request Body

email

string · required

Resend email confirmation for users who didn't receive their verification email. AU 12.4 › Responses

Response model for simple message replies.

message

string · required

POST/auth/api/v1/resendEmailConfirmation/

import requests

url = "/auth/api/v1/resendEmailConfirmation/"

payload = { "email": "email" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "email": "email"
}

json

Example Responses

{
  "message": "message"
}

json

application/json

User Logout. AU 12.5

POST

/auth/api/v1/logout/

Logout endpoint with business logic - personal users logout themselves, business admins can logout other users.

User Logout. AU 12.5 › Request Body optional

Request model for user logout.

User Logout. AU 12.5 › Responses

Response model for simple message replies.

message

string · required

POST/auth/api/v1/logout/

import requests

url = "/auth/api/v1/logout/"

payload = {
    "user_id": 0,
    "client_id": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "user_id": 0,
  "client_id": "string"
}

json

Example Responses

{
  "message": "message"
}

json

application/json

Password reset request endpoint. AU 12.6

POST

/auth/api/v1/forget-password/

Password reset request endpoint. Accepts email in the request body.

Password reset request endpoint. AU 12.6 › Request Body

email

string · required

Password reset request endpoint. AU 12.6 › Responses

Response model for simple message replies.

message

string · required

POST/auth/api/v1/forget-password/

import requests

url = "/auth/api/v1/forget-password/"

payload = { "email": "email" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "email": "email"
}

json

Example Responses

{
  "message": "message"
}

json

application/json

Delete account endpoint. AU 12.7

DELETE

/auth/api/v1/account/

Delete account endpoint. Accepts user_id in the request body.

Delete account endpoint. AU 12.7 › Request Body

Request model for soft deleting user account.

password

string · required

confirmation_text

string

Default: DELETE MY ACCOUNT

Delete account endpoint. AU 12.7 › Responses

Response model for account deletion.

message

string · required

deleted_at

string · required

user_id

integer · required

username

string · required

email

string · required

data_preserved

boolean

Default: true

can_restore

boolean

Default: true

DELETE/auth/api/v1/account/

import requests

url = "/auth/api/v1/account/"

payload = {
    "password": "password",
    "confirmation_text": "confirmation_text"
}
headers = {"Content-Type": "application/json"}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "password": "password",
  "confirmation_text": "confirmation_text"
}

json

Example Responses

{
  "message": "message",
  "deleted_at": "deleted_at",
  "user_id": 0,
  "username": "username",
  "email": "email",
  "data_preserved": true,
  "can_restore": true
}

json

application/json

Get current user profile information. AU 12.8

GET

/auth/api/v1/users/me/

Get current user profile information. Returns the currently authenticated user's comprehensive profile information (same structure as login response).

Get current user profile information. AU 12.8 › Responses

GET/auth/api/v1/users/me/

import requests

url = "/auth/api/v1/users/me/"

response = requests.get(url)

print(response.text)

python

Example Responses

{}

json

application/json

Update current user profile information. AU 12.9

PATCH

/auth/api/v1/users/me/

Update current user profile information. Accepts username, email, first name, last name in the request body.

Update current user profile information. AU 12.9 › Request Body

Request model for updating user information.

Update current user profile information. AU 12.9 › Responses

Response model for user information.

username

string · required

email

string · required

first_name

string · required

last_name

string · required

required

uuid

string · required

PATCH/auth/api/v1/users/me/

import requests

url = "/auth/api/v1/users/me/"

payload = {
    "username": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "username": "string",
  "email": "string",
  "first_name": "string",
  "last_name": "string"
}

json

Example Responses

{
  "username": "username",
  "email": "email",
  "first_name": "first_name",
  "last_name": "last_name",
  "last_login": "string",
  "profile_image_url": "string",
  "uuid": "uuid"
}

json

application/json

Get user's assigned pricing plans. AU 12.10

GET

/auth/api/v1/users/usage/

Get user's assigned pricing plans in paginated format.

Get user's assigned pricing plans. AU 12.10 › query Parameters

page

integer

Default: 1

page_size

integer

Default: 10

Get user's assigned pricing plans. AU 12.10 › Responses

200

count

integer · required

total_pages

integer · required

page

integer · required

page_size

integer · required

required

object[] · required

GET/auth/api/v1/users/usage/

import requests

url = "/auth/api/v1/users/usage/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "count": 0,
  "total_pages": 0,
  "page": 0,
  "page_size": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "id": 0,
      "owner_id": 0,
      "name": "name",
      "legal_name": "string",
      "description": "string",
      "email": "string",
      "phone": "string",
      "website": "string",
      "street": "string",
      "city": "string",
      "state": "string",
      "zip_code": "string",
      "business_id": "business_id",
      "ein": "string",
      "industry": "string",
      "organization_id": "string",
      "status": "status",
      "is_active": true,
      "is_verified": true,
      "verification_documents": [
        {}
      ],
      "verified_at": "2024-08-25T15:00:00Z",
      "verified_by_id": 0,
      "verification_notes": "string",
      "verification_status": "verification_status",
      "verification_required_documents": [
        {}
      ],
      "verification_submitted_at": "2024-08-25T15:00:00Z",
      "verification_reviewed_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Toggle notification subscription. AU 12.12

POST

/auth/api/v1/users/toggle_subscribe_notification/

Toggle notification subscription. Accepts notification_type in the request body.

Toggle notification subscription. AU 12.12 › Responses

Response model for simple message replies.

message

string · required

POST/auth/api/v1/users/toggle_subscribe_notification/

import requests

url = "/auth/api/v1/users/toggle_subscribe_notification/"

response = requests.post(url)

print(response.text)

python

Example Responses

{
  "message": "message"
}

json

application/json

Get email notification settings

GET

/auth/api/v1/users/notification-settings/

Return the email notification preferences for the authenticated user.

Get email notification settings › Responses

200

email_notifications_enabled

boolean · required

conversion_complete

boolean · required

conversion_failed

boolean · required

storage_warnings

boolean · required

marketing_emails_enabled

boolean · required

GET/auth/api/v1/users/notification-settings/

import requests

url = "/auth/api/v1/users/notification-settings/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "email_notifications_enabled": true,
  "conversion_complete": true,
  "conversion_failed": true,
  "storage_warnings": true,
  "marketing_emails_enabled": true
}

json

application/json

Update email notification settings

PATCH

/auth/api/v1/users/notification-settings/

Partially update email notification preferences for the authenticated user.

Update email notification settings › Request Body

Update email notification settings › Responses

200

email_notifications_enabled

boolean · required

conversion_complete

boolean · required

conversion_failed

boolean · required

storage_warnings

boolean · required

marketing_emails_enabled

boolean · required

PATCH/auth/api/v1/users/notification-settings/

import requests

url = "/auth/api/v1/users/notification-settings/"

payload = {
    "email_notifications_enabled": True,
    "conversion_complete": True,
    "conversion_failed": True,
    "storage_warnings": True,
    "marketing_emails_enabled": True
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

python

Example Request Body

{
  "email_notifications_enabled": true,
  "conversion_complete": true,
  "conversion_failed": true,
  "storage_warnings": true,
  "marketing_emails_enabled": true
}

json

Example Responses

{
  "email_notifications_enabled": true,
  "conversion_complete": true,
  "conversion_failed": true,
  "storage_warnings": true,
  "marketing_emails_enabled": true
}

json

application/json

Health OIDC Provider

Authentication & User Management

Unified Login Endpoint - Traditional (Username/Email/Password), Google OAuth & Apple Sign-In Authentication. AU 12.1

Unified Login Endpoint - Traditional (Username/Email/Password), Google OAuth & Apple Sign-In Authentication. AU 12.1 › Request Body

Unified Login Endpoint - Traditional (Username/Email/Password), Google OAuth & Apple Sign-In Authentication. AU 12.1 › Responses

Register endpoint - returns success message with rate limiting. AU 12.2

Register endpoint - returns success message with rate limiting. AU 12.2 › Request Body

Register endpoint - returns success message with rate limiting. AU 12.2 › Responses

Set new password endpoint - returns Bearer token with rate limiting. AU 12.3

Set new password endpoint - returns Bearer token with rate limiting. AU 12.3 › Request Body

Set new password endpoint - returns Bearer token with rate limiting. AU 12.3 › Responses

Change or set password endpoint. AU 12.5

Change or set password endpoint. AU 12.5 › Request Body

Change or set password endpoint. AU 12.5 › Responses

Resend email confirmation for users who didn't receive their verification email. AU 12.4

Resend email confirmation for users who didn't receive their verification email. AU 12.4 › Request Body

Resend email confirmation for users who didn't receive their verification email. AU 12.4 › Responses

User Logout. AU 12.5

User Logout. AU 12.5 › Request Body optional

User Logout. AU 12.5 › Responses

Password reset request endpoint. AU 12.6

Password reset request endpoint. AU 12.6 › Request Body

Password reset request endpoint. AU 12.6 › Responses

Delete account endpoint. AU 12.7

Delete account endpoint. AU 12.7 › Request Body

Delete account endpoint. AU 12.7 › Responses

Get current user profile information. AU 12.8

Get current user profile information. AU 12.8 › Responses

Update current user profile information. AU 12.9

Update current user profile information. AU 12.9 › Request Body

Update current user profile information. AU 12.9 › Responses

Get user's assigned pricing plans. AU 12.10

Get user's assigned pricing plans. AU 12.10 › query Parameters

Get user's assigned pricing plans. AU 12.10 › Responses

Toggle notification subscription. AU 12.12

Toggle notification subscription. AU 12.12 › Responses

Get email notification settings

Get email notification settings › Responses

Update email notification settings

Update email notification settings › Request Body

Update email notification settings › Responses