Indox Auth API - OSLLM AI

Multi-Factor Authentication

Download schema

Get Mfa Status

GET

/auth/api/v1/social/mfa/status/

Get user's MFA status and configuration.

🔒 Requires Authentication: Bearer token in Authorization header

Get Mfa Status › Responses

Response schema for MFA status.

is_enabled

boolean · required

methods

string[] · required

totp_enabled

boolean · required

sms_enabled

boolean · required

email_enabled

boolean · required

backup_codes_count

integer · required

security_score

integer · required

GET/auth/api/v1/social/mfa/status/

import requests

url = "/auth/api/v1/social/mfa/status/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "is_enabled": true,
  "methods": [
    "string"
  ],
  "totp_enabled": true,
  "sms_enabled": true,
  "email_enabled": true,
  "backup_codes_count": 0,
  "last_used": "string",
  "security_score": 0
}

json

application/json

Setup Totp

POST

/auth/api/v1/social/mfa/setup/totp/

Setup TOTP (Time-based OTP) for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Setup Totp › Responses

Response schema for TOTP setup.

secret_key

string · required

qr_code_url

string · required

manual_entry_key

string · required

backup_codes

string[] · required

POST/auth/api/v1/social/mfa/setup/totp/

import requests

url = "/auth/api/v1/social/mfa/setup/totp/"

response = requests.post(url)

print(response.text)

python

Example Responses

{
  "secret_key": "secret_key",
  "qr_code_url": "qr_code_url",
  "manual_entry_key": "manual_entry_key",
  "backup_codes": [
    "string"
  ]
}

json

application/json

Verify Totp Setup

POST

/auth/api/v1/social/mfa/verify/totp/

Verify TOTP setup with a test code.

🔒 Requires Authentication: Bearer token in Authorization header

Verify Totp Setup › Request Body

Request schema for verifying MFA.

method

string · required

code

string · required

Verify Totp Setup › Responses

POST/auth/api/v1/social/mfa/verify/totp/

import requests

url = "/auth/api/v1/social/mfa/verify/totp/"

payload = {
    "method": "method",
    "code": "code",
    "device_id": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "code": "code",
  "device_id": "string"
}

json

Example Responses

{}

json

application/json

Setup Sms

POST

/auth/api/v1/social/mfa/setup/sms/

Setup SMS MFA for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Setup Sms › Request Body

Request schema for enabling MFA.

method

string · required

Setup Sms › Responses

Response schema for SMS verification.

phone_number

string · required

verification_sent

boolean · required

expires_in

integer · required

POST/auth/api/v1/social/mfa/setup/sms/

import requests

url = "/auth/api/v1/social/mfa/setup/sms/"

payload = {
    "method": "method",
    "phone_number": "string",
    "email": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "phone_number": "string",
  "email": "string"
}

json

Example Responses

{
  "phone_number": "phone_number",
  "verification_sent": true,
  "expires_in": 0
}

json

application/json

Setup Email

POST

/auth/api/v1/social/mfa/setup/email/

Setup Email MFA for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Setup Email › Request Body

Request schema for enabling MFA.

method

string · required

Setup Email › Responses

Response schema for email verification.

email

string · required

verification_sent

boolean · required

expires_in

integer · required

POST/auth/api/v1/social/mfa/setup/email/

import requests

url = "/auth/api/v1/social/mfa/setup/email/"

payload = {
    "method": "method",
    "phone_number": "string",
    "email": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "phone_number": "string",
  "email": "string"
}

json

Example Responses

{
  "email": "email",
  "verification_sent": true,
  "expires_in": 0
}

json

application/json

Create Mfa Challenge

POST

/auth/api/v1/social/mfa/challenge/

Create an MFA challenge for authentication.

No authentication required - Used during login process

Create Mfa Challenge › Request Body

Request schema for verifying MFA.

method

string · required

code

string · required

Create Mfa Challenge › Responses

Response schema for MFA challenge.

challenge_id

string · required

methods_available

string[] · required

expires_in

integer · required

message

string · required

POST/auth/api/v1/social/mfa/challenge/

import requests

url = "/auth/api/v1/social/mfa/challenge/"

payload = {
    "method": "method",
    "code": "code",
    "device_id": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "code": "code",
  "device_id": "string"
}

json

Example Responses

{
  "challenge_id": "challenge_id",
  "methods_available": [
    "string"
  ],
  "expires_in": 0,
  "message": "message"
}

json

application/json

Verify Mfa Challenge

POST

/auth/api/v1/social/mfa/verify/

Verify an MFA challenge.

No authentication required - Used during login process

Verify Mfa Challenge › Request Body

Request schema for verifying MFA.

method

string · required

code

string · required

Verify Mfa Challenge › Responses

Response schema for successful MFA verification.

success

boolean · required

message

string · required

access_token

string · required

refresh_token

string · required

expires_in

integer · required

token_type

string

Default: Bearer

POST/auth/api/v1/social/mfa/verify/

import requests

url = "/auth/api/v1/social/mfa/verify/"

payload = {
    "method": "method",
    "code": "code",
    "device_id": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "code": "code",
  "device_id": "string"
}

json

Example Responses

{
  "success": true,
  "message": "message",
  "access_token": "access_token",
  "refresh_token": "refresh_token",
  "expires_in": 0,
  "token_type": "token_type"
}

json

application/json

Disable Mfa Method

POST

/auth/api/v1/social/mfa/disable/

Disable an MFA method for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Disable Mfa Method › Request Body

Request schema for disabling MFA.

method

string · required

verification_code

string · required

Disable Mfa Method › Responses

POST/auth/api/v1/social/mfa/disable/

import requests

url = "/auth/api/v1/social/mfa/disable/"

payload = {
    "method": "method",
    "verification_code": "verification_code"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "verification_code": "verification_code"
}

json

Example Responses

{}

json

application/json

Get Backup Codes

GET

/auth/api/v1/social/mfa/backup-codes/

Get user's backup codes.

🔒 Requires Authentication: Bearer token in Authorization header

Get Backup Codes › Responses

Response schema for backup codes.

codes

string[] · required

generated_at

string · required

expires_at

string · required

remaining_codes

integer · required

GET/auth/api/v1/social/mfa/backup-codes/

import requests

url = "/auth/api/v1/social/mfa/backup-codes/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "codes": [
    "string"
  ],
  "generated_at": "generated_at",
  "expires_at": "expires_at",
  "remaining_codes": 0
}

json

application/json

Regenerate Backup Codes

POST

/auth/api/v1/social/mfa/backup-codes/regenerate/

Regenerate backup codes for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Regenerate Backup Codes › Responses

Response schema for backup codes.

codes

string[] · required

generated_at

string · required

expires_at

string · required

remaining_codes

integer · required

POST/auth/api/v1/social/mfa/backup-codes/regenerate/

import requests

url = "/auth/api/v1/social/mfa/backup-codes/regenerate/"

response = requests.post(url)

print(response.text)

python

Example Responses

{
  "codes": [
    "string"
  ],
  "generated_at": "generated_at",
  "expires_at": "expires_at",
  "remaining_codes": 0
}

json

application/json

Get Mfa Devices

GET

/auth/api/v1/social/mfa/devices/

Get user's MFA devices.

🔒 Requires Authentication: Bearer token in Authorization header

Get Mfa Devices › Responses

Response schema for listing MFA devices.

object[] · required

total_count

integer · required

active_count

integer · required

GET/auth/api/v1/social/mfa/devices/

import requests

url = "/auth/api/v1/social/mfa/devices/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "devices": [
    {
      "id": 0,
      "method": "method",
      "name": "name",
      "is_active": true,
      "last_used": "string",
      "created_at": "created_at"
    }
  ],
  "total_count": 0,
  "active_count": 0
}

json

application/json

Get Mfa Security Info

GET

/auth/api/v1/social/mfa/security/

Get MFA security information for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Get Mfa Security Info › Responses

Response schema for MFA security information.

total_attempts

integer · required

successful_attempts

integer · required

failed_attempts

integer · required

blocked_attempts

integer · required

trusted_devices

integer · required

security_score

integer · required

recommendations

string[]

Default: []

GET/auth/api/v1/social/mfa/security/

import requests

url = "/auth/api/v1/social/mfa/security/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "total_attempts": 0,
  "successful_attempts": 0,
  "failed_attempts": 0,
  "blocked_attempts": 0,
  "last_used": "string",
  "trusted_devices": 0,
  "security_score": 0,
  "recommendations": [
    "string"
  ]
}

json

application/json

Social Authentication Google Drive Integration

Indox Auth API - OSLLM AI

Multi-Factor Authentication

Download schema

Get Mfa Status

GET

/auth/api/v1/social/mfa/status/

Get user's MFA status and configuration.

🔒 Requires Authentication: Bearer token in Authorization header

Get Mfa Status › Responses

Response schema for MFA status.

is_enabled

boolean · required

methods

string[] · required

totp_enabled

boolean · required

sms_enabled

boolean · required

email_enabled

boolean · required

backup_codes_count

integer · required

security_score

integer · required

GET/auth/api/v1/social/mfa/status/

import requests

url = "/auth/api/v1/social/mfa/status/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "is_enabled": true,
  "methods": [
    "string"
  ],
  "totp_enabled": true,
  "sms_enabled": true,
  "email_enabled": true,
  "backup_codes_count": 0,
  "last_used": "string",
  "security_score": 0
}

json

application/json

Setup Totp

POST

/auth/api/v1/social/mfa/setup/totp/

Setup TOTP (Time-based OTP) for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Setup Totp › Responses

Response schema for TOTP setup.

secret_key

string · required

qr_code_url

string · required

manual_entry_key

string · required

backup_codes

string[] · required

POST/auth/api/v1/social/mfa/setup/totp/

import requests

url = "/auth/api/v1/social/mfa/setup/totp/"

response = requests.post(url)

print(response.text)

python

Example Responses

{
  "secret_key": "secret_key",
  "qr_code_url": "qr_code_url",
  "manual_entry_key": "manual_entry_key",
  "backup_codes": [
    "string"
  ]
}

json

application/json

Verify Totp Setup

POST

/auth/api/v1/social/mfa/verify/totp/

Verify TOTP setup with a test code.

🔒 Requires Authentication: Bearer token in Authorization header

Verify Totp Setup › Request Body

Request schema for verifying MFA.

method

string · required

code

string · required

Verify Totp Setup › Responses

POST/auth/api/v1/social/mfa/verify/totp/

import requests

url = "/auth/api/v1/social/mfa/verify/totp/"

payload = {
    "method": "method",
    "code": "code",
    "device_id": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "code": "code",
  "device_id": "string"
}

json

Example Responses

{}

json

application/json

Setup Sms

POST

/auth/api/v1/social/mfa/setup/sms/

Setup SMS MFA for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Setup Sms › Request Body

Request schema for enabling MFA.

method

string · required

Setup Sms › Responses

Response schema for SMS verification.

phone_number

string · required

verification_sent

boolean · required

expires_in

integer · required

POST/auth/api/v1/social/mfa/setup/sms/

import requests

url = "/auth/api/v1/social/mfa/setup/sms/"

payload = {
    "method": "method",
    "phone_number": "string",
    "email": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "phone_number": "string",
  "email": "string"
}

json

Example Responses

{
  "phone_number": "phone_number",
  "verification_sent": true,
  "expires_in": 0
}

json

application/json

Setup Email

POST

/auth/api/v1/social/mfa/setup/email/

Setup Email MFA for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Setup Email › Request Body

Request schema for enabling MFA.

method

string · required

Setup Email › Responses

Response schema for email verification.

email

string · required

verification_sent

boolean · required

expires_in

integer · required

POST/auth/api/v1/social/mfa/setup/email/

import requests

url = "/auth/api/v1/social/mfa/setup/email/"

payload = {
    "method": "method",
    "phone_number": "string",
    "email": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "phone_number": "string",
  "email": "string"
}

json

Example Responses

{
  "email": "email",
  "verification_sent": true,
  "expires_in": 0
}

json

application/json

Create Mfa Challenge

POST

/auth/api/v1/social/mfa/challenge/

Create an MFA challenge for authentication.

No authentication required - Used during login process

Create Mfa Challenge › Request Body

Request schema for verifying MFA.

method

string · required

code

string · required

Create Mfa Challenge › Responses

Response schema for MFA challenge.

challenge_id

string · required

methods_available

string[] · required

expires_in

integer · required

message

string · required

POST/auth/api/v1/social/mfa/challenge/

import requests

url = "/auth/api/v1/social/mfa/challenge/"

payload = {
    "method": "method",
    "code": "code",
    "device_id": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "code": "code",
  "device_id": "string"
}

json

Example Responses

{
  "challenge_id": "challenge_id",
  "methods_available": [
    "string"
  ],
  "expires_in": 0,
  "message": "message"
}

json

application/json

Verify Mfa Challenge

POST

/auth/api/v1/social/mfa/verify/

Verify an MFA challenge.

No authentication required - Used during login process

Verify Mfa Challenge › Request Body

Request schema for verifying MFA.

method

string · required

code

string · required

Verify Mfa Challenge › Responses

Response schema for successful MFA verification.

success

boolean · required

message

string · required

access_token

string · required

refresh_token

string · required

expires_in

integer · required

token_type

string

Default: Bearer

POST/auth/api/v1/social/mfa/verify/

import requests

url = "/auth/api/v1/social/mfa/verify/"

payload = {
    "method": "method",
    "code": "code",
    "device_id": "string"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "code": "code",
  "device_id": "string"
}

json

Example Responses

{
  "success": true,
  "message": "message",
  "access_token": "access_token",
  "refresh_token": "refresh_token",
  "expires_in": 0,
  "token_type": "token_type"
}

json

application/json

Disable Mfa Method

POST

/auth/api/v1/social/mfa/disable/

Disable an MFA method for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Disable Mfa Method › Request Body

Request schema for disabling MFA.

method

string · required

verification_code

string · required

Disable Mfa Method › Responses

POST/auth/api/v1/social/mfa/disable/

import requests

url = "/auth/api/v1/social/mfa/disable/"

payload = {
    "method": "method",
    "verification_code": "verification_code"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

python

Example Request Body

{
  "method": "method",
  "verification_code": "verification_code"
}

json

Example Responses

{}

json

application/json

Get Backup Codes

GET

/auth/api/v1/social/mfa/backup-codes/

Get user's backup codes.

🔒 Requires Authentication: Bearer token in Authorization header

Get Backup Codes › Responses

Response schema for backup codes.

codes

string[] · required

generated_at

string · required

expires_at

string · required

remaining_codes

integer · required

GET/auth/api/v1/social/mfa/backup-codes/

import requests

url = "/auth/api/v1/social/mfa/backup-codes/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "codes": [
    "string"
  ],
  "generated_at": "generated_at",
  "expires_at": "expires_at",
  "remaining_codes": 0
}

json

application/json

Regenerate Backup Codes

POST

/auth/api/v1/social/mfa/backup-codes/regenerate/

Regenerate backup codes for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Regenerate Backup Codes › Responses

Response schema for backup codes.

codes

string[] · required

generated_at

string · required

expires_at

string · required

remaining_codes

integer · required

POST/auth/api/v1/social/mfa/backup-codes/regenerate/

import requests

url = "/auth/api/v1/social/mfa/backup-codes/regenerate/"

response = requests.post(url)

print(response.text)

python

Example Responses

{
  "codes": [
    "string"
  ],
  "generated_at": "generated_at",
  "expires_at": "expires_at",
  "remaining_codes": 0
}

json

application/json

Get Mfa Devices

GET

/auth/api/v1/social/mfa/devices/

Get user's MFA devices.

🔒 Requires Authentication: Bearer token in Authorization header

Get Mfa Devices › Responses

Response schema for listing MFA devices.

object[] · required

total_count

integer · required

active_count

integer · required

GET/auth/api/v1/social/mfa/devices/

import requests

url = "/auth/api/v1/social/mfa/devices/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "devices": [
    {
      "id": 0,
      "method": "method",
      "name": "name",
      "is_active": true,
      "last_used": "string",
      "created_at": "created_at"
    }
  ],
  "total_count": 0,
  "active_count": 0
}

json

application/json

Get Mfa Security Info

GET

/auth/api/v1/social/mfa/security/

Get MFA security information for the user.

🔒 Requires Authentication: Bearer token in Authorization header

Get Mfa Security Info › Responses

Response schema for MFA security information.

total_attempts

integer · required

successful_attempts

integer · required

failed_attempts

integer · required

blocked_attempts

integer · required

trusted_devices

integer · required

security_score

integer · required

recommendations

string[]

Default: []

GET/auth/api/v1/social/mfa/security/

import requests

url = "/auth/api/v1/social/mfa/security/"

response = requests.get(url)

print(response.text)

python

Example Responses

{
  "total_attempts": 0,
  "successful_attempts": 0,
  "failed_attempts": 0,
  "blocked_attempts": 0,
  "last_used": "string",
  "trusted_devices": 0,
  "security_score": 0,
  "recommendations": [
    "string"
  ]
}

json

application/json

Social Authentication Google Drive Integration