{"id":82763,"date":"2023-06-05T13:11:45","date_gmt":"2023-06-05T17:11:45","guid":{"rendered":"https:\/\/jumpcloud.com\/?post_type=support&#038;p=82763"},"modified":"2023-06-05T13:11:45","modified_gmt":"2023-06-05T17:11:45","slug":"ldap-api-attributes-for-user-lockout-and-password-expiration","status":"publish","type":"support","link":"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration","title":{"rendered":"LDAP API Attributes for User Lockout and Password Expiration"},"content":{"rendered":"\n<div class=\"wp-block-cgb-notification-card-wysiwyg notification-card note\"><div class=\"notification-card-content\"><div class=\"notification-card-icon\"><p><img decoding=\"async\" src=\"\/wp-content\/themes\/jumpcloud\/assets\/images\/gutenberg-blocks\/note-icon.png\" \/><\/p><\/div><div class=\"notification-card-copy is-type-body-default\"><div><strong class=\"notification-card-type\">Note:<\/strong> \n<p>This can also now be handled within the JumpCloud Admin Portal interface. See <a href=\"https:\/\/jumpcloud.com\/support\/manage-password-and-security-settings\" target=\"_blank\" rel=\"noreferrer noopener\">Manage Password and Security Settings<\/a>\u200b\u200b\u200b\u200b\u200b\u200b.<\/p>\n <\/div><\/div><\/div><\/div>\n\n\n\n<p>LDAP API Attributes<\/p>\n\n\n\n<p>Attributes are available for the JumpCloud V2 API <strong>\/ldapservers\/{id}<\/strong> endpoint. The values for each attribute are <strong>disable<\/strong> and <strong>remove<\/strong>:<\/p>\n\n\n\n<ul>\n<li><strong>userLockoutAction<\/strong> &#8211; This attribute controls the action taken when a user is locked out due to repeated failed login attempts. If set to <strong>remove<\/strong>, when a lockout occurs, the user is removed from the LDAP server and no longer exists in the LDAP service. If set to <strong>disable<\/strong>, when a lockout occurs, they remain in LDAP but can\u2019t authenticate against the LDAP service.<\/li>\n\n\n\n<li><strong>userPasswordExpirationAction<\/strong> &#8211; This attribute controls the action taken when a user\u2019s JumpCloud account password expires. If set to <strong>remove<\/strong>, the user is removed from the LDAP server and no longer exists in the LDAP service when their account password expires. If set to <strong>disable<\/strong>, they remain in LDAP but can\u2019t authenticate against the LDAP service when their password expires. To see a list of LDAP servers and their settings for the attributes, complete an HTTP GET request. See the Sample Requests below for an example GET call.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Sample Requests<\/h2>\n\n\n\n<p>The following sample is an example request of an HTTP PATCH call containing the new attributes.<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>curl -X PATCH https:\/\/console.jumpcloud.com\/api\/v2\/ldapservers\/{LDAP_ID} \\<br>-H &#8216;Accept: application\/json&#8217; \\<br>-H &#8216;Content-Type: application\/json&#8217; \\<br>-H &#8216;x-api-key: {API_KEY}&#8217; \\<br>-d &#8216;{<br>&#8220;userLockoutAction&#8221;: &#8220;remove&#8221;,<br>&#8220;userPasswordExpirationAction&#8221;: &#8220;disable&#8221;<br>}&#8217;<\/p>\n<\/div><\/div>\n\n\n\n<p>The following sample is an example request of an HTTP GET call to see a list of LDAP servers.<\/p>\n\n\n\n<div class=\"wp-block-cgb-code-block code-block\"><div class=\"code-block-snippet is-type-body-default\">\n<p>curl -X GET https:\/\/console.jumpcloud.com\/api\/v2\/ldapservers\/ \\<br>-H &#8216;Accept: application\/json&#8217; \\<br>-H &#8216;Content-Type: application\/json&#8217; \\<br>-H &#8216;x-api-key: {API_KEY}&#8217; \\<\/p>\n<\/div><\/div>\n\n\n\n<p>Be sure to replace <strong>{API_KEY}<\/strong> and <strong>{LDAP_ID}<\/strong> with your own values and remember to remove the brackets <strong>{ }<\/strong> around the values.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>LDAP API Attributes Attributes are available for the JumpCloud V2 API \/ldapservers\/{id} endpoint. The values for each attribute are disable [&hellip;]<\/p>\n","protected":false},"author":206,"featured_media":0,"template":"","meta":{"_acf_changed":false,"_oasis_is_in_workflow":0,"_oasis_original":0,"_oasis_task_priority":"","inline_featured_image":false,"footnotes":""},"support_category":[2917,2845,2856,2896,3004,2850],"support_tag":[],"coauthors":[2842],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v22.9 (Yoast SEO v22.9) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>LDAP API Attributes for User Lockout and Password Expiration - JumpCloud<\/title>\n<meta name=\"description\" content=\"Explore the LDAP API attributes for user lockout and password expiration.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"LDAP API Attributes for User Lockout and Password Expiration\" \/>\n<meta property=\"og:description\" content=\"Explore the LDAP API attributes for user lockout and password expiration.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration\" \/>\n<meta property=\"og:site_name\" content=\"JumpCloud\" \/>\n<meta property=\"og:image\" content=\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2024\/07\/202405-MISC-JumpCloudHelpCenter-SiteDisplay-min-2.png\" \/>\n\t<meta property=\"og:image:width\" content=\"890\" \/>\n\t<meta property=\"og:image:height\" content=\"525\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n\t<meta name=\"twitter:label2\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data2\" content=\"pamkellman\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration\",\"url\":\"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration\",\"name\":\"LDAP API Attributes for User Lockout and Password Expiration - JumpCloud\",\"isPartOf\":{\"@id\":\"https:\/\/jumpcloud.com\/#website\"},\"datePublished\":\"2023-06-05T17:11:45+00:00\",\"dateModified\":\"2023-06-05T17:11:45+00:00\",\"description\":\"Explore the LDAP API attributes for user lockout and password expiration.\",\"breadcrumb\":{\"@id\":\"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/jumpcloud.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Support\",\"item\":\"https:\/\/jumpcloud.com\/support\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"LDAP API Attributes for User Lockout and Password Expiration\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/jumpcloud.com\/#website\",\"url\":\"https:\/\/jumpcloud.com\/\",\"name\":\"JumpCloud\",\"description\":\"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.\",\"publisher\":{\"@id\":\"https:\/\/jumpcloud.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/jumpcloud.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/jumpcloud.com\/#organization\",\"name\":\"JumpCloud\",\"url\":\"https:\/\/jumpcloud.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"contentUrl\":\"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png\",\"width\":598,\"height\":101,\"caption\":\"JumpCloud\"},\"image\":{\"@id\":\"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"LDAP API Attributes for User Lockout and Password Expiration - JumpCloud","description":"Explore the LDAP API attributes for user lockout and password expiration.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration","og_locale":"en_US","og_type":"article","og_title":"LDAP API Attributes for User Lockout and Password Expiration","og_description":"Explore the LDAP API attributes for user lockout and password expiration.","og_url":"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration","og_site_name":"JumpCloud","og_image":[{"width":890,"height":525,"url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2024\/07\/202405-MISC-JumpCloudHelpCenter-SiteDisplay-min-2.png","type":"image\/png"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes","Written by":"pamkellman"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration","url":"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration","name":"LDAP API Attributes for User Lockout and Password Expiration - JumpCloud","isPartOf":{"@id":"https:\/\/jumpcloud.com\/#website"},"datePublished":"2023-06-05T17:11:45+00:00","dateModified":"2023-06-05T17:11:45+00:00","description":"Explore the LDAP API attributes for user lockout and password expiration.","breadcrumb":{"@id":"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/jumpcloud.com\/support\/ldap-api-attributes-for-user-lockout-and-password-expiration#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/jumpcloud.com\/"},{"@type":"ListItem","position":2,"name":"Support","item":"https:\/\/jumpcloud.com\/support"},{"@type":"ListItem","position":3,"name":"LDAP API Attributes for User Lockout and Password Expiration"}]},{"@type":"WebSite","@id":"https:\/\/jumpcloud.com\/#website","url":"https:\/\/jumpcloud.com\/","name":"JumpCloud","description":"Daily insights on directory services, IAM, LDAP, identity security, SSO, system management (Mac, Windows, Linux), networking, and the cloud.","publisher":{"@id":"https:\/\/jumpcloud.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/jumpcloud.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/jumpcloud.com\/#organization","name":"JumpCloud","url":"https:\/\/jumpcloud.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/","url":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","contentUrl":"https:\/\/jumpcloud.com\/wp-content\/uploads\/2021\/01\/jc-logo-brand-2021.png","width":598,"height":101,"caption":"JumpCloud"},"image":{"@id":"https:\/\/jumpcloud.com\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/82763"}],"collection":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support"}],"about":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/types\/support"}],"author":[{"embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/users\/206"}],"version-history":[{"count":3,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/82763\/revisions"}],"predecessor-version":[{"id":83100,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support\/82763\/revisions\/83100"}],"wp:attachment":[{"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/media?parent=82763"}],"wp:term":[{"taxonomy":"support_category","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_category?post=82763"},{"taxonomy":"support_tag","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/support_tag?post=82763"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/jumpcloud.com\/wp-json\/wp\/v2\/coauthors?post=82763"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}