UserGroup class - Platform - BlueCat Gateway - 19.8.1

Gateway Administration Guide

prodname
BlueCat Gateway
version_custom
19.8.1

BAM user entities.

class bluecat.user.User(api, api_entity)

Bases: bluecat.entity.Entity

BAM user entities.

API Call:

add_access_right(entity_id, value, overrides='', properties='')
Parameter Description
entity_id id of an entity the access right is applied to.
value The value of the access right being added.
overrides A list of type-specific overrides.
properties

A string including the following options:

  1. workflowLevel
  2. deploymentAllowed
  3. quickDeploymentAllowed

Returns: Object ID of the created Access Right.

add_to_group(group_id, properties='')

Link the user to the user group; adding the user to the group.

Parameter Description
group_id  
properties  

Returns:

delete()

Delete the entity from the BAM database.

dump()

Dump out details of the deployment role to stdout. Useful for debug.

get_access_right(recipient_id)

Get an AccessRight for this entity for a specific user or a user group. :param recipient_id: The object ID of the user or user group the access right is applied to. :return: an AccessRight object.

get_access_rights()

Get an iterator for all access rights for an Entity.

get_child_by_name(name, entity_type)

Get a specific named immediate child entity of a given type.

get_children_of_type(entity_type)

Get a specific named immediate child entity of a given type.

Parameter Description
entity_type Entity type to search for.

Returns: Generator object iterating over all children of specified type.

get_deployment_roles(types=None)

Get deployment roles for the entity.

Parameter Description
types An optional list of deployment role types (documented in the deployment_role class). If the list is empty all types are returned.

get_id()

Get the BAM ID of an entity.

get_linked_entities(entity_type)

Get all the linked entities of a given type.

Returns: Iterator for a given type entities.

get_name()

Get the BAM name of the entity.

get_parent()

Get the parent entity or None if the entity is at the top of the hierarchy.

get_parent_configuration()

Walk up the entity hierarchy and return the Configuration entity; if none was found, returns None; if starting entity is configuration, returns itself.

Returns: An iterator of parent configuration objects.

get_parent_of_type(entity_type)

Walk up the entity hierarchy and return the first parent entity of the given type or, if none was found, raise PortalException.

get_properties()

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

get_property()

Get a single named property or None if not defined.

get_tag_by_name(name)

Searches a Tag by name.

Parameter Description
name Name of the Tag.

Returns: A Tag object with the specified name.

get_tags()

Using Entity.

get_type()

Get the BAM type of the entity.

get_url()

Get URL.

is_null()

Is this the null entity? (ID == 0).

link_entity(entity_id, properties='')

Link caller Entity object with another whose ID is ‘entity_id’. This method can be called by any side of a linking relationship between Entity objects.

Parameters Description
entity_id The ID of the Entity object to be linked, or to link.
properties Adds object properties, including user-defined fields.

Returns: The caller Entity object.

name

Get the BAM name of the entity.

refresh()

Downloads an updated object from BAM.

set_name(new_name)

Set the BAM name of the entity.

set_property(name, value)

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

update()

Persist any changes to the entity to the BAM database.