Click a link to jump to the indicated section.
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 (int) |
id of an entity the access right is applied to. |
| value (str) |
The value of the access right being added. |
| overrides (str, optional) |
A list of type-specific overrides. |
| properties (str, optional) |
A string including the following options:
|
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 (int) |
Id of a User Group to which user will be added. |
| properties (str, optional) |
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 (int) |
id of an entity the access right is applied to.. |
Return type: AccessRight
Returns: an AccessRight object.
get_access_rights()
Get an iterator for all access rights for a user
Return type: Iterator
get_user_groups()
Get any user groups to which the user belongs.
Return type: list
Returns: List of UserGroup Entity objects.
remove_from_group(group_id, properties='')
Remove the user from a group.
| Parameters | Description |
|---|---|
| group_id (int) |
Id of a User Group from which user will be removed. |
| properties (str, optional) |
Adds object properties, including user-defined fields. |
Returns: None.