foliolib.folio.api.fincConfig.FincSelectEZBCredentials

class foliolib.folio.api.fincConfig.FincSelectEZBCredentials(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

mod-finc-config EZB Credentials API

This documents the API calls that can be made to query and manage EZB credentials for the current tenant/isil

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`delete_ezbCredentials`()	Delete ezb credential
`get_ezbCredentials`()	Get the ezb credential of current tenant
`modify_ezbCredential`(ezbCredential)	Add or edit an ezb credential entry

delete_ezbCredentials()

Delete ezb credential

DELETE /finc-select/ezb-credentials

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error

get_ezbCredentials()

Get the ezb credential of current tenant

GET /finc-select/ezb-credentials

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "EZB Credential",
  "description": "Single EZB Credential schema",
  "properties": {
    "id": {
      "description": "ID of cred entry.",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
      "readOnly": true
    },
    "user": {
      "type": "string",
      "description": "The user name"
    },
    "password": {
      "type": "string",
      "description": "The password"
    },
    "libId": {
      "type": "string",
      "description": "The library id"
    },
    "isil": {
      "type": "string",
      "description": "Isil of library of this credential entry. Needs to be unique. Hence, there is only one ezb credential per library."
    }
  },
  "required": [
    "user",
    "password",
    "libId"
  ]
}

modify_ezbCredential(ezbCredential: dict)

Add or edit an ezb credential entry

PUT /finc-select/ezb-credentials

Parameters

ezbCredential (dict) – See Schema below

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "EZB Credential",
  "description": "Single EZB Credential schema",
  "properties": {
    "id": {
      "description": "ID of cred entry.",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
      "readOnly": true
    },
    "user": {
      "type": "string",
      "description": "The user name"
    },
    "password": {
      "type": "string",
      "description": "The password"
    },
    "libId": {
      "type": "string",
      "description": "The library id"
    },
    "isil": {
      "type": "string",
      "description": "Isil of library of this credential entry. Needs to be unique. Hence, there is only one ezb credential per library."
    }
  },
  "required": [
    "user",
    "password",
    "libId"
  ]
}