APIObject class - Platform - BlueCat Gateway - 18.2.1

Gateway Administration Guide

prodname
BlueCat Gateway
version_custom
18.2.1

classapi_object.APIObject(api, api_entity, ver='')

Bases: object

Instantiate a base class for API Entity or an Access Right.

Parameter Description
api API instance used by the API object to communicate with BAM.
api_entity The API object returned by the BAM API.

dump()

Dump out details of the entity to stdout. Useful for debug.

get_properties()

Get the properties in the form of a dictionary containing one entry per property.

get_property (name)

Get a single named property or None if not defined.

set_property (name,value)

Set a property value. The change is not persisted until update() is called.