All applications below support trusted mode; i_customer should be supplied in that mode.

Customers can use their own policies, the policy assigned to their Customer, and global policies. Only the owner can update or delete a policy. The system policy is read-only.

createPasswordPolicy()

This application is used to create a password policy.

Required parameters:

  • name - Policy name, unique within a Customer. String, 1 to 64 characters.

Optional parameters:

  • description - Description. String, up to 256 characters.
  • min_length - Minimum password length. Integer, 1 to 32. Default is 14.
  • i_password_content - Password content type (see below). Integer. Default is 5.
  • change_first_login - Require a web-password change on first login. Boolean. Default is true.
  • immutable - Prevent self-service password changes. Boolean. Default is false.
  • expires - Web-password lifetime in days. Positive integer, or null to disable. Default is 90.
  • block_idle_in - Idle period for restricting web login, in days. Positive integer, or null to disable. Default is 90.
  • global - Make the policy available to other Customers. Boolean. Default is false. Only root can enable it.
  • use_as_default - Use for new Accounts, Customers, and Vendors. Boolean. Default is false.

Password content types:

  • 1 - Letters and Digits: require at least one letter and one digit.
  • 2 - Letters: require at least one letter.
  • 3 - Digits: require at least one digit.
  • 4 - Any Characters: no character-type requirement.
  • 5 - Upper/Lower Letters, Digits and Special: require at least one of each.

Other character types are also allowed. The maximum password length is 32.

Setting use_as_default clears the previous local default. If no local default is selected, the policy assigned to the Customer is used. Existing objects keep their assigned policies.

Returns:

  • result - OK - String.
  • i_password_policy - ID of the newly created policy. Integer.
  • XMLRPC fault in case of any error.

updatePasswordPolicy()

This application is used to update a password policy.

Required parameters:

  • i_password_policy - ID of the policy to update. Integer.

Optional parameters:

The same optional parameters as createPasswordPolicy(), plus name. Omitted fields remain unchanged. Non-root callers must omit global.

Returns:

  • result - OK - String.
  • i_password_policy - ID of the updated policy. Integer.
  • XMLRPC fault in case of any error.

deletePasswordPolicy()

This application is used to delete a password policy. Policies assigned to an Account, Customer, or Vendor cannot be deleted.

Required parameters:

  • i_password_policy - ID of the policy to delete. Integer.

Returns:

  • result - OK - String.
  • i_password_policy - ID of the deleted policy. Integer.
  • XMLRPC fault in case of any error.

getPasswordPolicyInfo()

This application is used to get password policy details.

Required parameters:

  • i_password_policy - ID of a policy. Integer.

Returns:

  • result - OK - String.
  • password_policy - Structure with policy attributes, including i_password_policy and the owner's i_customer.
  • password_policy.read_only - Whether the policy is read-only for the caller. Boolean.
  • password_policy.use_as_default - Whether this is the effective default for the caller's Customer. Boolean.
  • password_policy.global - Global visibility. Boolean. Returned only to root.
  • XMLRPC fault in case of any error.

getPasswordPoliciesList()

This application is used to list available password policies, ordered by name.

Optional parameters:

  • name_pattern - Policy-name filter using SQL ILIKE syntax. String.
  • offset - Number of policies to skip. Non-negative integer. Default is 0.
  • limit - Maximum policies per page. Positive integer. Default is 50.

Returns:

  • result - OK - String.
  • password_policies - Array of structures with the attributes returned by getPasswordPolicyInfo().
  • password_policies.own_policy - Whether this policy is assigned to the caller's Customer. Boolean.
  • pagination - Structure with page, items_per_page, and total_items. Integers.
  • XMLRPC fault in case of any error.