Password Expiry

(NB: Not yet available)

Summary

Password Expiry API is for retrieving the status of password of current user. Including information such as expiry date, days to expire and whether user is within expiry reminder period.

Contents

Operation
Retrieve the password expiry information

Operations

Retrieve password expiry info

This endpoint returns the password last updated date, expiry date, server date, password configuration expiration days and days to remind user, days to expiry, is within expiry reminder period, is SSO user and whether the password is expired.

Example

In this example, we request the password expiry endpoint

Request

GET /tasks/actions/workspace/123 HTTP/1.1
Accept: application/vnd.huddle.data+json
Authorization: OAuth2 frootymcnooty/vonbootycherooty

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+json

{
    "lastUpdateDate": "2024-05-30T08:00:49.697",
    "expiryDate": "2024-06-29T08:00:49.697",
    "serverDate": "2024-06-06T08:13:06.8626058Z",
    "expirationDay": 30,
    "expiryReminder": 10,
    "daysToExpire": 23,
    "isWithinReminderPeriod": false,
    "isExpired": false
}

Response properties:

Response Property	Data Type	Comment	Optional
lastUpdateDate	DateTime OR null	Password last updated date
expiryDate	DateTime OR null	Password expiry date
serverDate	DateTime	Current server date
expirationDay	Number	Password Configuration password expiration day
expiryReminder	Number	Password Configuration days to expiry reminder
daysToExpire	Number	Days left to password expire
isWithinReminderPeriod	Boolean	Whether password days to expiry fall within Password Configuration days to expiry reminder
IsSSOUser	True OR undefined	Whether user has SSO setup	Yes
isExpired	Boolean	Whether password already expired

The response in the default success scenario will be 200. Other possible response codes include:

Response Code	Meaning
401	No authentication was provided
403	No authentication user was found
500	Server Internal Error