Get Organization Settings
Retrieve the current organization-wide settings, including multi-factor authentication requirements and password policy configuration.
Request
GET /organization/settings
Authentication
Requires an Admin Bearer JWT token.
Authorization: Bearer <access_token>
Query Parameters
None.
Response
Returns the organization settings object.
Success Response
Status Code: 200 OK
Response Body:
{
"mfaRequired": true,
"passwordMinLength": 12,
"passwordRequireUppercase": true,
"passwordRequireLowercase": true,
"passwordRequireDigit": true,
"passwordRequireSpecialChar": true,
"passwordExpirationDays": 90
}
Response Fields
| Field | Type | Description |
|---|---|---|
mfaRequired | boolean | Whether multi-factor authentication is required for all users |
passwordMinLength | integer | Minimum password length (typically 8-128) |
passwordRequireUppercase | boolean | Whether passwords must contain uppercase letters |
passwordRequireLowercase | boolean | Whether passwords must contain lowercase letters |
passwordRequireDigit | boolean | Whether passwords must contain at least one digit |
passwordRequireSpecialChar | boolean | Whether passwords must contain at least one special character |
passwordExpirationDays | integer | Number of days before passwords expire (null for no expiration) |
Errors
| Status Code | Error Code | Description |
|---|---|---|
401 | UNAUTHORIZED | Missing or invalid JWT token |
403 | FORBIDDEN | User does not have admin privileges |
Example
Request
curl -X GET https://api.entryguard.io/api/v1/organization/settings \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Response
{
"mfaRequired": true,
"passwordMinLength": 12,
"passwordRequireUppercase": true,
"passwordRequireLowercase": true,
"passwordRequireDigit": true,
"passwordRequireSpecialChar": true,
"passwordExpirationDays": 90
}
Notes
- These settings apply to all users in the organization.
- Password policy changes only affect new passwords; existing passwords are not retroactively validated.
- Enabling
mfaRequiredwill force all users without MFA to set it up on their next login. - Password expiration is calculated from the last password change date.