afv-library/skills/platform-metadata-api-context-get/data/metadata_api/ProfilePasswordPolicy.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "ProfilePasswordPolicy - Metadata API",
  "description": "Represents a profile’s password policies. Profile password policies override org-wide password policies for that profile’s users. Use ProfilePasswordPolicy to retrieve password policies for a given profile. This type extends the Metadata metadata type and inherits its fullName field.",
  "file_information": ".profilePasswordPolicy",
  "directory_location": "profilePasswordPolicies",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "forgotPasswordRedirect": {
      "type": "boolean",
      "description": "If true, reset password links in forgot password emails don’t immediately expire the first time they’re clicked. Instead, the links stay active until a user confirms the password reset request on an interstitial page. The default value is false. This field is available in API version 43.0 and later."
    },
    "lockoutInterval": {
      "type": "int",
      "description": "The duration of the login lockout, in minutes. If users are locked out, they must wait until the lockout period expires. Valid values: 0, 15, 30, 60.",
      "required": true
    },
    "maxLoginAttempts": {
      "type": "int",
      "description": "The number of times a user can enter a wrong password before getting locked out. Valid values: 0, 3, 5, 10.",
      "required": true
    },
    "minimumPasswordLength": {
      "type": "int",
      "description": "Minimum number of characters required for a password. Valid values: 5 – 50.",
      "required": true
    },
    "minimumPasswordLifetime": {
      "type": "boolean",
      "description": "If true, a user cannot change a password more than once in a 24-hour period."
    },
    "obscure": {
      "type": "boolean",
      "description": "If true, answers to security questions are hidden as the user types."
    },
    "passwordComplexity": {
      "type": "int",
      "description": "Level of complexity required for the character types in a user’s password. If 0, the password can contain any type of character. If 1, the password must contain at least one alphabetic character and 1 number. If 2, the password must contain at least one alphabetic character, one number, and one of the following special characters: ! # $ % - _ = + < >. If 3, the password must contain at least one number, one uppercase letter, and one lowercase letter. If 4, the password must contain at least one number, one uppercase letter, one lowercase letter, and one of the following special characters: ! # $ % - _ = + < >.",
      "required": true
    },
    "passwordExpiration": {
      "type": "int",
      "description": "Number of days until user passwords expire and must be changed. Valid values: 0—If set to 0, the password never expires. 30 60 90 180 365",
      "required": true
    },
    "passwordHistory": {
      "type": "int",
      "description": "Number of previous passwords to save. Saving passwords is required to ensure that users reset their password to a new, unique password. This value must be set before a password reset succeeds. If 0, passwordExpiration must be set to 0.",
      "required": true
    },
    "passwordQuestion": {
      "type": "int",
      "description": "If set to 1, the answer to the password hint cannot contain the password itself. If 0, the answer has no restrictions.",
      "required": true
    },
    "profile": {
      "type": "string",
      "description": "Name of the user profile.",
      "required": true
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ProfilePasswordPolicy\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"forgotPasswordRedirect\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"lockoutInterval\" type=\"xsd:int\"/>\n        <xsd:element name=\"maxLoginAttempts\" type=\"xsd:int\"/>\n        <xsd:element name=\"minimumPasswordLength\" type=\"xsd:int\"/>\n        <xsd:element name=\"minimumPasswordLifetime\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"obscure\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"passwordComplexity\" type=\"xsd:int\"/>\n        <xsd:element name=\"passwordExpiration\" type=\"xsd:int\"/>\n        <xsd:element name=\"passwordHistory\" type=\"xsd:int\"/>\n        <xsd:element name=\"passwordQuestion\" type=\"xsd:int\"/>\n        <xsd:element name=\"profile\" type=\"xsd:string\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "The following is an example of a ProfilePasswordPolicy component.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ProfilePasswordPolicy xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <forgotPasswordRedirect>true</forgotPasswordRedirect>    \n    <lockoutInterval>30</lockoutInterval>\n    <maxLoginAttempts>0</maxLoginAttempts>\n    <minimumPasswordLength>7</minimumPasswordLength>\n    <minimumPasswordLifetime>false</minimumPasswordLifetime>\n    <obscure>false</obscure>\n    <passwordComplexity>1</passwordComplexity>\n    <passwordExpiration>0</passwordExpiration>\n    <passwordHistory>0</passwordHistory>\n    <passwordQuestion>1</passwordQuestion>\n    <profile>platformportal</profile>\n</ProfilePasswordPolicy>"
    }
  ]
}