Skip to main content

Retrieve User Settings

Retrieves the current user settings of the platform.

HTTP Request

GET/api/settings/users

Authorization

Authorization

  • Required: Yes
  • Permission: Staff or Admin
  • Authentication: Token authentication

Example Requests

1import requests
2
3# Retrieve user settings
4response = requests.get('http://www.example.com/api/settings/users', 
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())

Status Codes

CodeDescription
200Request logs retrieved successfully
400Bad request — invalid query parameters
401Unauthorized — authentication required
403Forbidden — insufficient permissions
500Internal server error

Response Fields

FieldTypeDescription
users_default_user_statusBooleanDefault status for new users (default: false)
users_allow_multiple_sessionsBooleanAllow users to have multiple active sessions (default: false)
users_otp_code_lenIntegerLength of OTP codes (default: 5)
users_otp_code_ttlIntegerOTP code time-to-live in seconds (default: 120)