API docs by Redocly

Validator Registry (v1)

getTenantRules

Get a list of existing validation rules for a tenant

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

query
string

A query string to filter rules based on matching criteria in fields.

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ],
  • "totalRecords": 0
}

postTenantRules

Add a rule to a tenant

Request Body schema: application/json
required
id
string

Rule id

ruleId
string

Rule id

name
required
string

Rule name

type
required
string
Enum: "RegExp" "Programmatic" "PwnedPassword"

Rule type: RegExp or Programmatic or PwnedPassword

validationType
required
string
Enum: "Soft" "Strong"

Validation type: Strong or Soft. In case of soft rule validation failure the password processing can be continued

state
required
string
Enum: "Enabled" "Disabled"

Rule state: Enabled or Disabled

moduleName
required
string

Name of the module

implementationReference
string

For Programmatic rules ImplementationReference reflects the approach to call particular validation implementation whether it REST endpoint or local service

expression
string

For RegExp type contains the actual expression

description
string

Validation rule description

orderNo
required
integer

Defines the order of rule processing

errMessageId
string

message identifier which should be returned to UI in case the rule validation fails

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "ruleId": "string",
  • "name": "string",
  • "type": "RegExp",
  • "validationType": "Soft",
  • "state": "Enabled",
  • "moduleName": "string",
  • "implementationReference": "string",
  • "expression": "string",
  • "description": "string",
  • "orderNo": 0,
  • "errMessageId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ruleId": "string",
  • "name": "string",
  • "type": "RegExp",
  • "validationType": "Soft",
  • "state": "Enabled",
  • "moduleName": "string",
  • "implementationReference": "string",
  • "expression": "string",
  • "description": "string",
  • "orderNo": 0,
  • "errMessageId": "string",
  • "metadata": {
    }
}

putTenantRule

Enable/disable/change the rule

Request Body schema: application/json
required
id
string

Rule id

ruleId
string

Rule id

name
required
string

Rule name

type
required
string
Enum: "RegExp" "Programmatic" "PwnedPassword"

Rule type: RegExp or Programmatic or PwnedPassword

validationType
required
string
Enum: "Soft" "Strong"

Validation type: Strong or Soft. In case of soft rule validation failure the password processing can be continued

state
required
string
Enum: "Enabled" "Disabled"

Rule state: Enabled or Disabled

moduleName
required
string

Name of the module

implementationReference
string

For Programmatic rules ImplementationReference reflects the approach to call particular validation implementation whether it REST endpoint or local service

expression
string

For RegExp type contains the actual expression

description
string

Validation rule description

orderNo
required
integer

Defines the order of rule processing

errMessageId
string

message identifier which should be returned to UI in case the rule validation fails

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "ruleId": "string",
  • "name": "string",
  • "type": "RegExp",
  • "validationType": "Soft",
  • "state": "Enabled",
  • "moduleName": "string",
  • "implementationReference": "string",
  • "expression": "string",
  • "description": "string",
  • "orderNo": 0,
  • "errMessageId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "ruleId": "string",
  • "name": "string",
  • "type": "RegExp",
  • "validationType": "Soft",
  • "state": "Enabled",
  • "moduleName": "string",
  • "implementationReference": "string",
  • "expression": "string",
  • "description": "string",
  • "orderNo": 0,
  • "errMessageId": "string",
  • "metadata": {
    }
}

getTenantRuleById

path Parameters
ruleId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "ruleId": "string",
  • "name": "string",
  • "type": "RegExp",
  • "validationType": "Soft",
  • "state": "Enabled",
  • "moduleName": "string",
  • "implementationReference": "string",
  • "expression": "string",
  • "description": "string",
  • "orderNo": 0,
  • "errMessageId": "string",
  • "metadata": {
    }
}