foliolib.folio.api.fincConfig.FincConfigEZBCredentials

class foliolib.folio.api.fincConfig.FincConfigEZBCredentials(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 all tenants/isils

Parameters

• tenant (str) – Tenant id

• okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

delete_ezbCredential(isil)	Delete an ezb credentials entry identified by isil
get_ezbCredential(isil)	Get one ezb credentials entry by isil
get_ezbCredentials(**kwargs)	Return a list of ezb credentials (credentials of all tenants)
modify_ezbCredential(isil, ezbCredential)	Put an ezb credentials entry identified by isil
set_ezbCredential(ezbCredential)	Create an ezb credential

delete_ezbCredential(isil: str)

Delete an ezb credentials entry identified by isil

DELETE /finc-config/ezb-credentials/{isil}

Parameters

isil (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

get_ezbCredential(isil: str)

Get one ezb credentials entry by isil

GET /finc-config/ezb-credentials/{isil}

Parameters

isil (str) –

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"
  ]
}

get_ezbCredentials(**kwargs)

Return a list of ezb credentials (credentials of all tenants)

GET /finc-config/ezb-credentials

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• query (str) –

  A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

  Example

  • (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode

• offset (int) –

  (default=0) Skip over a number of elements by specifying an offset value for the query

  Example

  • 0

• limit (int) –

  (default=10) Limit the number of elements returned in the response

  Example

  • 10

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Collection of EZB credentials",
  "properties": {
    "credentials": {
      "type": "array",
      "description": "List of EZB credentials",
      "id": "credentials",
      "items": {
        "type": "object",
        "$ref": "ezbCredential.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "credentials",
    "totalRecords"
  ]
}

modify_ezbCredential(isil: str, ezbCredential: dict)

Put an ezb credentials entry identified by isil

PUT /finc-config/ezb-credentials/{isil}

Parameters

• isil (str) –

• ezbCredential (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• 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"
  ]
}

set_ezbCredential(ezbCredential: dict)

Create an ezb credential

POST /finc-config/ezb-credentials

Parameters

ezbCredential (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created ezbCredential item

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"
  ]
}