Group

This module provides access to the group REST api of Camunda.

Group

class pycamunda.group.Group(id_: str, name: str, type_: Optional[str] = None)

Data class of group as returned by the REST api of Camunda.

type_ = None

Get

class pycamunda.group.Get(url: str, id_: str)

Get a group.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the group.
__call__(*args, **kwargs) → pycamunda.group.Group

Send the request.

GetList

class pycamunda.group.GetList(url, id_: Optional[str] = None, id_in: Optional[Iterable[str]] = None, name: Optional[str] = None, name_like: Optional[str] = None, type_: Optional[str] = None, member: Optional[str] = None, member_of_tenant: Optional[str] = None, sort_by: Optional[str] = None, ascending: bool = True, first_result: Optional[int] = None, max_results: Optional[int] = None)

Get a list of groups.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Filter by the id of the group.
  • id_in – Filter whether the id of the group is one of multiple ones.
  • name – Filter by the name of the group.
  • name_like – Filter by a substring of the name of the group.
  • type – Filter by the type of the group.
  • member – Filter by a member of the group.
  • member_of_tenant – Filter by member of the tenant.
  • sort_by – Sort the results by id_, name or type_.
  • ascending – Sort order.
  • first_result – Pagination of results. Index of the first result to return.
  • max_results – Pagination of results. Maximum number of results to return.
__call__(*args, **kwargs) → Tuple[pycamunda.group.Group]

Send the request.

Create

class pycamunda.group.Create(url: str, id_: str, name: str, type_: str)

Create a new group.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the group.
  • name – Name of the group.
  • type – Type of the group.
__call__(*args, **kwargs) → None

Send the request.

Update

class pycamunda.group.Update(url: str, id_: str, name: str, type_: str)

Update a group.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the group.
  • name – New name of the group.
  • type – New zype of the group.
__call__(*args, **kwargs) → None

Send the request.

Options

class pycamunda.group.Options(url: str, id_=None)

Get a list of options the currently authenticated user can perform on the group resource.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the user.
__call__(*args, **kwargs)

Send the request

Delete

class pycamunda.group.Delete(url: str, id_: str)

Delete a group.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the group.
__call__(*args, **kwargs) → None

Send the request.

MemberCreate

class pycamunda.group.MemberCreate(url: str, id_: str, user_id: str)

Add a member to a group.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the group.
  • user_id – Id of the user.
__call__(*args, **kwargs) → None

Send the request.

MemberDelete

class pycamunda.group.MemberDelete(url: str, id_: str, user_id: str)

Delete a member from a group.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the group.
  • user_id – Id of the user.
__call__(*args, **kwargs) → None

Send the request.

MemberOptions

class pycamunda.group.MemberOptions(url: str, id_: str)

Get a list of options the currently authenticated user can perform on the group member resource.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the group.
__call__(*args, **kwargs) → pycamunda.resource.ResourceOptions

Send the request.