Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Get security policy

GET
/api/v1/instance/security-policy
curl --request GET \
  --url https://example.com/api/v1/instance/security-policy \
  --cookie ttx_access_token=<ttx_access_token>

The instance’s password and second-factor rules.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SecurityPolicyRead
object
accounts_without_totp
required
MfaPolicyCounts
object
evaluator
required
Evaluator
integer
observer
required
Observer
integer
planner
required
Planner
integer
player
required
Player
integer
program_manager
required
Program Manager
integer
mfa
required
MfaPolicyFields

Whether each role must have a second factor. The instance administrator always must, so it has no field.

object
evaluator
required
Evaluator
boolean
observer
required
Observer
boolean
planner
required
Planner
boolean
player
required
Player
boolean
program_manager
required
Program Manager
boolean
password
required
PasswordPolicyFields
object
history_count
required
History Count
integer
<= 24
max_age_days
Any of:
integer
>= 1 <= 730
min_length
required
Min Length
integer
>= 8 <= 64
reject_personal
required
Reject Personal
boolean

Example generated

{
  "accounts_without_totp": {
    "evaluator": 1,
    "observer": 1,
    "planner": 1,
    "player": 1,
    "program_manager": 1
  },
  "mfa": {
    "evaluator": true,
    "observer": true,
    "planner": true,
    "player": true,
    "program_manager": true
  },
  "password": {
    "history_count": 1,
    "max_age_days": 1,
    "min_length": 1,
    "reject_personal": true
  }
}