Credential / Settings

What can you do with CredentialSettings?


Properties

Property Details
id
"id": 9
Type: Number
This is the unique numeric identifier for the CredentialSettings
ownerId
"ownerId": 12
Type: Number
Unique identifier for the associated Owner object.
expiryInDays
"expiryInDays": 886
Type: Number
applyBlackoutList
"applyBlackoutList": true
Type: Boolean
daysOfHistory
"daysOfHistory": 503
Type: Number
minimumLength
"minimumLength": 737
Type: Number
requiresLowerCase
"requiresLowerCase": 86
Type: Number
validLowerCase
"validLowerCase": "Hello World"
Type: String
requiresUpperCase
"requiresUpperCase": 727
Type: Number
validUpperCase
"validUpperCase": "Hello World"
Type: String
requiresNumber
"requiresNumber": 306
Type: Number
validNumber
"validNumber": "Hello World"
Type: String
requiresSymbol
"requiresSymbol": 639
Type: Number
validSymbol
"validSymbol": "Hello World"
Type: String
failedLoginCountMaximum
"failedLoginCountMaximum": 6
Type: Number
resetLinkValidFor
"resetLinkValidFor": 710
Type: Number
validCharactersOnly
"validCharactersOnly": true
Type: Boolean


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • expiryInDays
  • applyBlackoutList
  • daysOfHistory
  • minimumLength
  • requiresLowerCase
  • validLowerCase
  • requiresUpperCase
  • validUpperCase
  • requiresNumber
  • validNumber
  • requiresSymbol
  • validSymbol
  • failedLoginCountMaximum
  • resetLinkValidFor
  • validCharactersOnly

DataFlow PATCH objects:


End Points

DELETEapi/v1/Credential/Settings/{id:int}
Delete an instance of the CredentialSettings object.
GETapi/v1/Credential/Settings
Retrieve all of the CredentialSettings objects.
GETapi/v1/Credential/Settings/Metadata
Retrieve all of the meta data details of the CredentialSettings object.
GETapi/v1/Credential/Settings/Metadata/{option}
Retrieve all the meta data details of the CredentialSettings object based on provided options.
{option}Metadata options for the CredentialSettings object.
GETapi/v1/Credential/Settings/Paged
Retreive all of the CredentialSettings objects in a paged fashion.
GETapi/v1/Credential/Settings/{id:int}
Retrieve an instance of the CredentialSettings object by it's ID.
{id:int}Unique identifier for the CredentialSettings object.
POSTapi/v1/Credential/Settings
Create a new instance of the CredentialSettings object.
PUTapi/v1/Credential/Settings/{id:int}
Update an existing instance of the CredentialSettings object.