POST api/v{version}/password/CheckPasswordExpiry

Checks to see if a password for a given user has expired. Note that this method assumes the password passed into the request has been authenticated successfully.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 2.0

Body Parameters

The check password expiry request

CheckPasswordExpiryRequest
NameDescriptionTypeAdditional information
UserId

The user Id

 string

None.
Password

The password

 string

None.
CredentialsType

The type of credentials being used.

 CredentialsType

None.

Request Formats

application/json, text/json, application/problem+json

Sample: 
{
  "userId": "sample string 1",
  "password": "sample string 2",
  "credentialsType": 0
}

application/xml, text/xml

Sample: 
<CheckPasswordExpiryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <CredentialsType>Client</CredentialsType>
  <Password>sample string 2</Password>
  <UserId>sample string 1</UserId>
</CheckPasswordExpiryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns true if the password is expired. False otherwise.

boolean

Response Formats

application/json, text/json, application/problem+json

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>