foliolib.folio.api.passwordValidator.Passwordvalidator

class foliolib.folio.api.passwordValidator.Passwordvalidator(tenant: str)

Bases: foliolib.folio.FolioApi

Password validator module

Base class of the Folio API

Parameters

tenant (str) – Tenant id

Methods

validatepassword(password)

Validate password

validatepassword(password)

Validate password

POST /tenant/password/validate

Parameters

password (dict) – See Schema below.

Returns

See Schema below.

Return type

dict

Raises

• OkapiRequestError – Bad request

• OkapiRequestNotFound – Not found error

• OkapiRequestUnprocessableEntity – Validation errors

• OkapiRequestFatalError – Internal server error

Schema

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Object with password property",
    "type": "object",
    "properties": {
        "password": {
            "type": "string",
            "description": "Password"
        },
        "userId": {
            "type": "string",
            "description": "User Id"
        }
    },
    "additionalProperties": false,
    "required": [
        "password",
        "userId"
    ]
}

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Validation Result Template",
    "type": "object",
    "properties": {
        "result": {
            "type": "string",
            "description": "validation result"
        },
        "messages": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "validation messages"
        }
    }
}