Skip to main content

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

FieldTypeDescription
mfaRequiredbooleanWhether multi-factor authentication is required for all users
passwordMinLengthintegerMinimum password length (typically 8-128)
passwordRequireUppercasebooleanWhether passwords must contain uppercase letters
passwordRequireLowercasebooleanWhether passwords must contain lowercase letters
passwordRequireDigitbooleanWhether passwords must contain at least one digit
passwordRequireSpecialCharbooleanWhether passwords must contain at least one special character
passwordExpirationDaysintegerNumber of days before passwords expire (null for no expiration)

Errors

Status CodeError CodeDescription
401UNAUTHORIZEDMissing or invalid JWT token
403FORBIDDENUser 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 mfaRequired will force all users without MFA to set it up on their next login.
  • Password expiration is calculated from the last password change date.