swimlane.core.resources.usergroup module

class swimlane.core.resources.usergroup.Group(*args, **kwargs)[source]

Bases: UserGroup

Swimlane group record

description

Group description

Type:

str

users

List of users belonging to group.

Type:

GroupUsersCursor

get_cache_index_keys()[source]

Return dict of key/value pairs used by ResourceCache to map resource values to internal cache instance

property 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)[source]

Bases: SwimlaneResolver, Cursor

Handles retrieval for user endpoint

class swimlane.core.resources.usergroup.User(*args, **kwargs)[source]

Bases: UserGroup

Swimlane user record

username

Unique username

Type:

str

display_name

User display name

Type:

str

email

User email

Type:

str

get_cache_index_keys()[source]

Return dict of key/value pairs used by ResourceCache to map resource values to internal cache instance

class swimlane.core.resources.usergroup.UserGroup(*args, **kwargs)[source]

Bases: 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

Full user/group ID

Type:

str

name

User/group name

Type:

str

as_usergroup_selection()[source]

Converts UserGroup to raw UserGroupSelection for populating record

Returns:

Formatted UserGroup data as used by selection fields

Return type:

dict

for_json()[source]

Get JSON-compatible representation

resolve()[source]

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