AccessRight class - Platform - BlueCat Gateway - 21.11.2

Gateway Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
21.11.2

class bluecat.access_right.AccessRight(api, api_entity)

Bases: bluecat.api_object.APIObject

BAM Access Rights. This class inherits APIObject and not Entity.

delete()

Delete the access right from the BAM database.

get_entity_id()

Returns: The object ID of the entity to which the access right is assigned. This value is not mutable.

get_override(name)

Parameters Description
name An object type of the override.

Returns: Get a single named override or None if not defined.

get_overrides()

Returns: Get the type-specific overrides in the form of a dictionary containing one entry per override.

get_recipient_id()

Returns: The object ID of the user or user group to whom the access right is assigned. This value is not mutable.

get_value()

Returns: A set value for the access right.

refresh()

Downloads an updated Access Right from BAM.

set_override(name, value)

Set an override value. The change is not persisted until update() is called.

Parameters Description
name objectType to be overridden.
value New access value.

set_value(value)

Parameters Description
value New value for the access right.

update()

Persist any changes to the access right object to the BAM database. Please note that updates will work only if there is an explicit Access Right that was added previously and neither entity_Id nor recipient_id is changed.

Returns: Persisted Access Right object.