User class - Platform - BlueCat Gateway - 18.2.1

Gateway Administration Guide

prodname
BlueCat Gateway
version_custom
18.2.1

classbluecat.user.User(api, api_entity)

Bases: bluecat.entity.Entity

BAM user entities.

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

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 Id of a User Group to which user will be added.
properties Adds object properties, including user-defined fields.

get_access_right(entity_id)

Get an AccessRight for a specific entity.

Parameter Description
entity_id Id of an entity the access right is applied to.

Returns: An AccessRight object.

get_access_rights()

Get an iterator for all access rights for an Entity.

get_user_groups()

Get any user groups to which the user belongs.

remove_from_group(group_id, properties='')

Remove the user from a group.

Parameters Description
group_id Id of a User Group from which user will be removed.
properties Adds object properties, including user-defined fields.