SIP Password rules¶

Retrieve SIP password rules¶

GET /api/v1/system/sip_password_rules/¶

Retrieve all the security rules that a SIP password should follow.

Authorization rights: minimum End User.

Example request:

GET /api/v1/system/sip_password_rules/ HTTP/1.1
Host: example.com

{}

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
      "disallowAuthenticationName": true,
      "disallowOldPassword": false,
      "restrictMinDigits": false,
      "disallowReversedOldPassword": false,
      "minDigits": 1,
      "restrictMinUpperCaseLetters": false,
      "minUpperCaseLetters": 1,
      "restrictMinLowerCaseLetters": false,
      "minLowerCaseLetters": 1,
      "restrictMinNonAlphanumericCharacters": false,
      "minNonAlphanumericCharacters": 1,
      "minLength": 6,
      "sendPermanentLockoutNotification": false,
      "permanentLockoutNotifyEmailAddress": "eeee@eee.it",
      "endpointAuthenticationLockoutType": "None",
      "endpointTemporaryLockoutThreshold": 5,
      "endpointWaitAlgorithm": "Double",
      "endpointLockoutFixedMinutes": 5,
      "endpointPermanentLockoutThreshold": 5,
      "trunkGroupAuthenticationLockoutType": "None",
      "trunkGroupTemporaryLockoutThreshold": 5,
      "trunkGroupWaitAlgorithm": "Double",
      "trunkGroupLockoutFixedMinutes": 5,
      "trunkGroupPermanentLockoutThreshold": 5,
}

Request JSON Object:

disallowAuthenticationName (boolean) – It is not allowed to use the SIP Authentication name into password.
disallowOldPassword (boolean) – It is not allowed to reuse the current password as new one.
disallowReversedOldPassword (boolean) – It is not allowed to reuse the current password in reverse order as new one.
restrictMinDigits (boolean) – Restriction on minimum number of Digits enabled.
minDigits (integer) – Minimum number of Digits (if enable).
restrictMinUpperCaseLetters (boolean) – Restriction on minimum number of Upper Case letters enabled.
minUpperCaseLetters (integer) – Minimum number of Upper Case (if enable).
restrictMinLowerCaseLetters (boolean) – Restriction on minimum number of Lower Case letters enabled.
minLowerCaseLetters (integer) – Minimum number of Lower Case (if enable).
restrictMinNonAlphanumericCharacters (boolean) – Restriction on minimum number of Non AlphaNumeric characters enabled.
minNonAlphanumericCharacters (integer) – Minimum number of Non AlphaNumeric characters (if enable).
minLength (integer) – Minimum length of the password.
sendPermanentLockoutNotification (boolean) – Send an email to an admin when Permanent Lockout is disabled.
permanentLockoutNotifyEmailAddress (string) – email address for the disabled permanent Lockout Notify
endpointAuthenticationLockoutType (string) –
Authentication Lockout type for device profile/SIP authentication password rules.
Possible values:
- None
- Temporary
- Temporary Then Permanent
endpointTemporaryLockoutThreshold (integer) – Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout.
endpointWaitAlgorithm (string) –
Wait algorithm type for device profile/SIP authentication password rules.
Possible values: Double and Fixed.
- Double: the previous lockout time (Starting with 5 minutes).
- Fixed: Wait a fixed amount of time
endpointLockoutFixedMinutes (integer) –
Number of minutes to wait when AuthenticationLockoutWaitAlgorithmType is set to fixed.
Possible values:
- 5
- 10
- 20
- 40
- 60
endpointPermanentLockoutThreshold (integer) – Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout.
trunkGroupAuthenticationLockoutType (string) –
Authentication Lockout type for device profile/SIP authentication password rules.

value comes from list: ‘None’, ‘Temporary’, ‘Temporary Then Permanent’
trunkGroupTemporaryLockoutThreshold (integer) – Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout.
trunkGroupWaitAlgorithm (string) –
Wait algorithm type for device profile/SIP authentication password rules.
Possible values: Double and Fixed.
- Double: the previous lockout time (Starting with 5 minutes).
- Fixed: Wait a fixed amount of time
trunkGroupLockoutFixedMinutes (integer) –
Number of minutes to wait when AuthenticationLockoutWaitAlgorithmType is set to fixed.
Possible values:
- 5
- 10
- 20
- 40
- 60
trunkGroupPermanentLockoutThreshold (integer) – Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout.

Status Codes:

200 OK – no error

Update SIP password rules¶

PUT /api/v1/system/sip_password_rules/¶

Update the security rules that a SIP password should follow for this System.

Authorization Right:minimum System Admin.

Example request:

PUT /api/v1/api/v1/system/sip_password_rules/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "minDigits": 2,
   "restrictMinLowerCaseLetters": true,
   "minLowerCaseLetters": 2,
   "minLength": 8
}

Example response:

Response:

Similar to GET instance method response.

Response JSON Object:

disallowAuthenticationName (boolean) – It is not allowed to use the SIP Authentication name into password.
disallowOldPassword (boolean) – It is not allowed to reuse the current password as new one.
disallowReversedOldPassword (boolean) – It is not allowed to reuse the current password in reverse order as new one.
restrictMinDigits (boolean) – Restriction on minimum number of Digits enabled.
minDigits (integer) – Minimum number of Digits (if enable).
restrictMinUpperCaseLetters (boolean) – Restriction on minimum number of Upper Case letters enabled.
minUpperCaseLetters (integer) – Minimum number of Upper Case (if enable).
restrictMinLowerCaseLetters (boolean) – Restriction on minimum number of Lower Case letters enabled.
minLowerCaseLetters (integer) – Minimum number of Lower Case (if enable).
restrictMinNonAlphanumericCharacters (boolean) – Restriction on minimum number of Non AlphaNumeric characters enabled.
minNonAlphanumericCharacters (integer) – Minimum number of Non AlphaNumeric characters (if enable).
minLength (integer) – Minimum length of the password.
sendPermanentLockoutNotification (boolean) – Send an email to an admin when Permanent Lockout is disabled.
permanentLockoutNotifyEmailAddress (string) – email address for the disabled permanent Lockout Notify
endpointAuthenticationLockoutType (string) –
Authentication Lockout type for device profile/SIP authentication password rules.
Possible values:
- None
- Temporary
- Temporary Then Permanent
endpointTemporaryLockoutThreshold (integer) – Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout.
endpointWaitAlgorithm (string) –
Wait algorithm type for device profile/SIP authentication password rules.
Possible values: Double and Fixed.
- Double: the previous lockout time (Starting with 5 minutes).
- Fixed: Wait a fixed amount of time
endpointLockoutFixedMinutes (integer) –
Number of minutes to wait when AuthenticationLockoutWaitAlgorithmType is set to fixed.
Possible values:
- 5
- 10
- 20
- 40
- 60
endpointPermanentLockoutThreshold (integer) – Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout.
trunkGroupAuthenticationLockoutType (string) –
Authentication Lockout type for device profile/SIP authentication password rules.
Possible values:
- None
- Temporary
- Temporary Then Permanent
trunkGroupTemporaryLockoutThreshold (integer) – Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout.
trunkGroupWaitAlgorithm (string) –
Wait algorithm type for device profile/SIP authentication password rules.
Possible values: Double and Fixed.
- Double: the previous lockout time (Starting with 5 minutes).
- Fixed: Wait a fixed amount of time
trunkGroupLockoutFixedMinutes (integer) –
Number of minutes to wait when AuthenticationLockoutWaitAlgorithmType is set to fixed.
Possible values:
- 5
- 10
- 20
- 40
- 60
trunkGroupPermanentLockoutThreshold (integer) – Device profile/SIP authentication password rules can be used to specify the maximum authentication attempts before temporary lockout.

Status Codes:

200 OK – no error
400 Bad Request – error in the input data, most probably due to incorrect values.