user module - Platform - BlueCat Gateway - 21.11.2

Gateway Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
21.11.2

BAM user entities.

class bluecat.user.User(api, api_entity)

Bases: bluecat.entity.Entity

BAM user entities.

add_access_right(entity_id, value, overrides='', properties='')

Parameters 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 a created Access Right.

add_to_group(group_id, properties='')

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

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

Returns: None.

get_access_right(entity_id)

Get an AccessRight for a specific entity.

Parameters 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 a user

get_user_groups()

Get any user groups to which the user belongs.

Returns: List of UserGroup Entity objects.

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.

Returns: None.