{"id":"sforce_api_objects_userlogin","title":"UserLogin","content":"<a name=\"sforce_api_objects_userlogin\"><!-- --></a><h1 class=\"helpHead1\">UserLogin</h1><div class=\"body refbody\">\n<div class=\"shortdesc\">\n<span class=\"ph\" id=\"summary\"><a name=\"summary\"><!-- --></a>Represents the settings that affect a user’s ability to log\n      into an organization. To access this object, you need the\n        <span class=\"keyword parmname\">UserPermissions.ManageUsers</span> permission. </span>This object is available\n    in API version 29.0 and later.</div>\n\n    <div class=\"section\">\n<h2 class=\"helpHead2\">Supported Calls</h2>\n\n      \n      <p class=\"p\"><samp class=\"codeph nolang\">describeSObjects()</samp>, <samp class=\"codeph nolang\">query()</samp>, <samp class=\"codeph nolang\">retrieve()</samp>, <samp class=\"codeph nolang\">update()</samp></p>\n\n    </div>\n\n    <div class=\"section\">\n<h2 class=\"helpHead2\">Fields</h2>\n\n      \n      \n<div class=\"data colSort\"><table class=\"featureTable sort_table\" summary=\"\">\n          \n          \n          <thead class=\"thead sorted\" align=\"left\">\n            <tr>\n              <th class=\"featureTableHeader  \" id=\"d2113319e80\">Field Name</th>\n\n              <th class=\"featureTableHeader  \" id=\"d2113319e83\">Details</th>\n\n            </tr>\n\n          </thead>\n\n          <tbody class=\"tbody\">\n            <tr>\n              <td class=\"entry\" headers=\"d2113319e80\" data-title=\"Field Name\"><span class=\"keyword parmname\">IsFrozen</span></td>\n\n              <td class=\"entry\" headers=\"d2113319e83\" data-title=\"Details\">\n                <dl class=\"dl detailList\">\n                  \n                    <dt class=\"dt dlterm\">Type</dt>\n\n                    <dd class=\"dd\">boolean</dd>\n\n                  \n                  \n                    <dt class=\"dt dlterm\">Properties</dt>\n\n                    <dd class=\"dd\">Defaulted on create,\n                        Filter,\n                        Group, Sort, Update</dd>\n\n                  \n                  \n                    <dt class=\"dt dlterm\">Description</dt>\n\n                    <dd class=\"dd\">If <samp class=\"codeph nolang\">true</samp>, the user account associated\n                      with this object is <a class=\"xref\" href=\"https://help.salesforce.com/s/articleView?id=platform.users_freeze.htm&amp;language=en_US\" target=\"_blank\">frozen</a>. If a user's account is frozen,\n                      they can't log in, but their account isn't deactivated.</dd>\n\n                  \n                </dl>\n\n              </td>\n\n            </tr>\n\n            <tr>\n              <td class=\"entry\" headers=\"d2113319e80\" data-title=\"Field Name\"><span class=\"keyword parmname\">IsPasswordLocked</span></td>\n\n              <td class=\"entry\" headers=\"d2113319e83\" data-title=\"Details\">\n                <dl class=\"dl detailList\">\n                  \n                    <dt class=\"dt dlterm\">Type</dt>\n\n                    <dd class=\"dd\">boolean</dd>\n\n                  \n                  \n                    <dt class=\"dt dlterm\">Properties</dt>\n\n                    <dd class=\"dd\">Defaulted on create,\n                        Filter,\n                        Group, Sort, Update</dd>\n\n                  \n                  \n                    <dt class=\"dt dlterm\">Description</dt>\n\n                    <dd class=\"dd\">If <samp class=\"codeph nolang\">true</samp>, the user account associated\n                      with this object is locked because of too many login failures. From the API,\n                      you can set this field to <samp class=\"codeph nolang\">false</samp>, but not\n                        <samp class=\"codeph nolang\">true</samp>. <div class=\"box message info\"><div class=\"inner\"><div class=\"bd\"><div class=\"media\">\n<img class=\"img mtm\" src=\"/docs/resources/img/en-us/264.0?doc_id=images%2Ficon_note.png&folder=object_reference\" alt=\"Note\"><div class=\"mediaBd\">\n<h4 class=\"mbs\">Note</h4>\n<p>If the Lockout effective\n                        period is set to Forever (must be reset by admin) in your org’s Password\n                        Policies Setup page, this field isn’t set to <samp class=\"codeph nolang\">false</samp>.</p>\n</div>\n</div></div></div></div>\n</dd>\n\n                  \n                </dl>\n\n              </td>\n\n            </tr>\n\n            <tr>\n              <td class=\"entry\" headers=\"d2113319e80\" data-title=\"Field Name\"><span class=\"keyword parmname\">UserId</span></td>\n\n              <td class=\"entry\" headers=\"d2113319e83\" data-title=\"Details\">\n                <dl class=\"dl detailList\">\n                  \n                    <dt class=\"dt dlterm\">Type</dt>\n\n                    <dd class=\"dd\">reference</dd>\n\n                  \n                  \n                    <dt class=\"dt dlterm\">Properties</dt>\n\n                    <dd class=\"dd\">Filter,\n                        Group, Nillable, Sort</dd>\n\n                  \n                  \n                    <dt class=\"dt dlterm\">Description</dt>\n\n                    <dd class=\"dd\">ID of the associated user account. This field can’t be updated.</dd>\n\n                  \n                </dl>\n\n              </td>\n\n            </tr>\n\n          </tbody>\n\n        </table></div>\n\n    </div>\n\n    <div class=\"section\">\n<h2 class=\"helpHead2\">Usage</h2>\n<div class=\"p\">To query for all frozen users in your\n        organization:<div class=\"codeSection soql\"><pre class=\"codeblock brush:plain\">SELECT Id, UserId\nFROM UserLogin\nWHERE IsFrozen = true</pre></div>\n</div>\n<p class=\"p\">To freeze or unfreeze multiple users, <a class=\"xref\" href=\"https://help.salesforce.com/s/articleView?id=000387522&amp;type=1&amp;language=en_US\" target=\"_blank\">use Data Loader</a>.</p>\n</div>\n\n  </div><div id=\"sfdc:seealso\" class=\"related-links\"></div>"}