Skip to main content

Update User Settings

Updates the current user settings of the project

HTTP Request

PATCH/api/settings/users

Authorization

Authorization

  • Required: Yes
  • Permission: Staff with UsersSettingsPermission or Admin
  • Permission Code: 1012
  • Authentication: Token authentication

Request Body

FieldTypeRequiredDescription
users_default_user_statusBooleanNoDefault status for new users (active or not, default: false)
users_allow_multiple_sessionsBooleanNoAllow users to have multiple active sessions (default: false)
users_otp_code_lenIntegerNoLength of OTP codes (default: 5)
users_otp_code_ttlIntegerNoOTP code time-to-live in seconds (default: 120)

Example Requests

1# Update user settings
2response = requests.patch('http://www.example.com/api/settings/users', 
3  json={
4      'users_default_user_status': True,
5      'users_allow_multiple_sessions': True,
6      'users_otp_code_len': 6,
7      'users_otp_code_ttl': 300
8  },
9  headers={'Authorization': 'Token <your_api_key>'}
10)
11print(response.json())

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)

Example Response

{
"users_default_user_status": true,
"users_allow_multiple_sessions": false,
"users_otp_code_len": 6,
"users_otp_code_ttl": 60
}