swimlane.core.resources.usergroup module

class swimlane.core.resources.usergroup.Group(swimlane, raw)

Bases: swimlane.core.resources.usergroup.UserGroup

Swimlane group record

description

str – Group description

users

GroupUsersCursor – List of users belonging to group.

get_cache_index_keys()

users

Returns a GroupUsersCursor with list of User instances for this Group

New in version 2.16.2.

class swimlane.core.resources.usergroup.GroupUsersCursor(swimlane, user_ids)

Bases: swimlane.core.resolver.SwimlaneResolver, swimlane.core.cursor.Cursor

Handles retrieval for user endpoint

class swimlane.core.resources.usergroup.User(swimlane, raw)

Bases: swimlane.core.resources.usergroup.UserGroup

Swimlane user record

username

str – Unique username

display_name

str – User display name

email

str – User email

get_cache_index_keys()

class swimlane.core.resources.usergroup.UserGroup(swimlane, raw)

Bases: swimlane.core.resources.base.APIResource

Base class for Users and Groups

Notes

Returned in some places where determining whether object is a User or Group is not possible without additional requests. Use appropriate adapter on swimlane client to retrieve more specific instance using id as needed

Can be compared to User or Group instances directly without ensuring the classes are the same

id

str – Full user/group ID

name

str – User/group name

as_usergroup_selection()

Converts UserGroup to raw UserGroupSelection for populating record

Returns:Formatted UserGroup data as used by selection fields Return type:dict

resolve()

Retrieve and return correct User or Group instance from UserGroup

New in version 2.16.1.

Returns:Resolved User or Group instance Return type:User | Group