REST API:passwordPolicy Resource

REST API:passwordPolicy Resource

From LongJump Support Wiki

REST API:passwordPolicy Resource
Jump to: navigation, search

Manage Password Policies using the REST APIs

Contents

Permissions

File:Lock-tiny.gif

Users that have the Access Control permission can modify the password policy. 

Get the Password Policy

Retrieves Password Policy information.

Method
GET
URI
https://na.longjump.com/networking/rest/passwordPolicy
Response
<platform>
    <passwordPolicy>
        <min_length>6</min_length>
        <characters_type>2</characters_type>
        <expiry_frequency>0</expiry_frequency>
        <last_matching_limit>1</last_matching_limit>
        <password_min_age>2</password_min_age>
        <session_timeout>120</session_timeout>
        <try_limit>10</try_limit>
        <lockout_duration>15</lockout_duration>
        <excluded_ids>123qwe345rty,678yui901abc,...</excluded_ids>
        <date_modified>2010-11-12T13:14:15Z</date_modified>
        <created_id type="USER"
         uri="https://{domain}/networking/rest/user/3"
         displayValue=" System">3</created_id>
        <modified_id type="USER"
         uri="https://{domain}/networking/rest/user/657hik947abc"
         displayValue="Bob Smith">657hik947abc</modified_id>
    </passwordPolicy>
   
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Update the Password Policy

Updates a Password Policy

Method
PUT
URI
https://na.longjump.com/networking/rest/passwordPolicy
Request
<platform>
    <passwordPolicy>
        <min_length>6</min_length>
        <characters_type>2</characters_type>
        <expiry_frequency>0</expiry_frequency>
        <last_matching_limit>1</last_matching_limit>
        <password_min_age>2</password_min_age>
        <session_timeout>120</session_timeout>
        <try_limit>10</try_limit>
        <lockout_duration>15</lockout_duration>
        <excluded_ids>123qwe345rty,678yui901abc,...</excluded_ids>    
    </passwordPolicy>              
</platform>
Response
<platform>
    <message>
        <code>0</code>
        <description>Success</description>        
    </message>
</platform>
See also: REST API:Error Codes

Fields

Name Type Attribute Default Value Description Additional Information
min_length Integer Editable on Add/Update 6 Minimum numbers of characters in the password Range: 6-10
characters_type Integer Editable on Add/Update 1 Types of characters and character combinations required for passwords
  • 1 - No restrictions
  • 2 - Alphanumerics
  • 3 - Alphanumerics, Upper case character required
  • 4 - Alphanumerics, Special character required: #$%@
  • 5 - Alphanumerics, Upper case and special character required
expiry_frequency Integer Editable on Add/Update 90 Number of days the password remains valid before the user will be prompted to change it Values: 15, 30, 60, 90, 120, 0 (never)
last_matching_limit Integer Editable on Add/Update 1 Number of previous passwords the new password may not match Range: 1-5
password_min_age Integer Editable on Add/Update 0 Number of days that must elapse before a user can change passwords Range: 0-5
session_timeout Integer Editable on Add/Update 30 Number of minutes an application will remain active with no user activity Values: 15, 30, 60, 90, 120
try_limit Integer Editable on Add/Update 5 Number of failed login attempts before account is locked out Range: 3-10, or 0 (no limit)
lockout_duration Integer Editable on Add/Update 15 Number of minutes user must wait before login can be attempted again Values: 5, 10, 15, 30, 60, 0 (disable account)
excluded_ids String Editable on Add/Update Comma-separated list of users who do not have to update their password
date_createdDateRead Only UTC Format
created_idLookupRead Only
date_modifiedDateRead Only UTC Format
modified_idLookup Read Only
Personal tools