swimlane.core.adapters.usergroup module¶

class swimlane.core.adapters.usergroup.GroupAdapter(swimlane)[source]¶

Handles retrieval of Swimlane Group resources

get(*args, **kwargs)[source]¶

Retrieve single group record by id or name

Supports resource cache

Keyword Arguments:
	id (str) – Full Group ID name (str) – Group name
Raises:	`TypeError` – Unexpected or more than one keyword argument provided `ValueError` – No matching group found based on provided inputs
Returns:	Group instance matching provided inputs
Return type:	Group

list(limit=None)[source]¶

Retrieve list of all groups

Returns:	List of all Groups
Return type:	`list` of `Group`

class swimlane.core.adapters.usergroup.GroupListCursor(swimlane, limit=None)[source]¶

Handles retrieval and pagination of group list endpoint

class swimlane.core.adapters.usergroup.UserAdapter(swimlane)[source]¶

Handles retrieval of Swimlane User resources

get(*args, **kwargs)[source]¶

Retrieve single user record by id or username

Warning

User display names are not unique. If using display_name, method will fail if multiple Users are returned with the same display name

Keyword Arguments:
	id (str) – Full User ID display_name (str) – User display name
Returns:	User instance matching provided inputs
Return type:	User
Raises:	`TypeError` – Unexpected or more than one keyword argument provided `ValueError` – No matching user found based on provided inputs, or multiple Users with same display name

list(limit=None)[source]¶

Retrieve all users

Returns:	Paginated cursor yielding `User` instances
Return type:	`UserListCursor`

class swimlane.core.adapters.usergroup.UserListCursor(swimlane, limit=None)[source]¶

Handles retrieval and pagination for user list endpoint