Purpose

Resets user account passwords for all user accounts across the system by providing a password expiration in number of days. When the passwords expire, the users must reset their passwords.

Warning:
  • When set to 0 (zero), passwords for user accounts expire immediately.
  • A password reset applies to all users, including users with the NoPasswordExpiration (30) permission and administrators.
  • If the password for a user account is set to expire sooner than the specified number of days, that password's expiration will not be changed.

URL

https://<myserver>:<port>/api/admin/users/expirepassword

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Request Definition


{
  "daysUntilExpiration": integer
}
Property Description Usage Valid Values
"daysUntilExpiration" Specifies the number of days the passwords for user accounts will expire Required 0 | x

0 expires passwords for user accounts immediately and requires that users reset their passwords.

x specifies the number of days in which the passwords of user accounts will expire.

Sample Request Payload 


{
  "daysUntilExpiration": 28
}

Sample Server Response 


      Status code: 200
      Successful response

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission.