Tenant

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

Tenant

class pycamunda.tenant.Tenant(id_: str, name: str)

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

UserMemberCreate

class pycamunda.tenant.UserMemberCreate(url: str, id_: str, user_id: str)

Create a membership between a tenant and an user.

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

Send the request.

UserMemberDelete

class pycamunda.tenant.UserMemberDelete(url: str, id_: str, user_id: str)

Delete a membership between a tenant and an user.

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

Send the request.

UserMemberOptions

class pycamunda.tenant.UserMemberOptions(url: str, id_: str)

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

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

Send the request

GroupMemberCreate

class pycamunda.tenant.GroupMemberCreate(url: str, id_: str, group_id: str)

Create a membership between a tenant and a group.

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

Send the request.

GroupMemberDelete

class pycamunda.tenant.GroupMemberDelete(url: str, id_: str, group_id: str)

Delete a membership between a tenant and a group.

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

Send the request.

GroupMemberOptions

class pycamunda.tenant.GroupMemberOptions(url: str, id_: str)

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

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

Send the request

GetList

class pycamunda.tenant.GetList(url: str, id_: Optional[str] = None, name: Optional[str] = None, name_like: Optional[str] = None, user_member: Optional[str] = None, group_member: Optional[str] = None, including_groups_of_user: bool = False, sort_by: Optional[str] = None, ascending: bool = True, first_result: Optional[int] = None, max_results: Optional[int] = None)

Query for a list of tenants using a list of parameters. The size of the result set can be retrieved by using the Count class.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Filter by the id of the tenant.
  • name – Filter by the name of the tenant.
  • name_like – Filter by a substring of the name.
  • user_member – Filter for tenants where the given user is member of.
  • group_member – Filter for tenants where the given group is a member of.
  • including_groups_of_user – Filter for tenants where the user or one of his groups is a member of. Can only be used with user_member parameter.
  • sort_by – Sort the results by id_ or name of the tenant.
  • 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.tenant.Tenant]

Send the request

Count

class pycamunda.tenant.Count(url: str, id_: Optional[str] = None, name: Optional[str] = None, name_like: Optional[str] = None, user_member: Optional[str] = None, group_member: Optional[str] = None, including_groups_of_user: bool = False)

Count tenants.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Filter by the id of the tenant.
  • name – Filter by the name of the tenant.
  • name_like – Filter by a substring of the name.
  • user_member – Filter for tenants where the given user is member of.
  • group_member – Filter for tenants where the given group is a member of.
  • including_groups_of_user – Filter for tenants where the user or one of his groups is a member of. Can only be used with user_member parameter.
__call__(*args, **kwargs) → int

Send the request

Get

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

Get a tenant.

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

Send the request

Create

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

Create a new tenant.

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

Send the request

Update

class pycamunda.tenant.Update(url: str, id_: str, new_id: str, new_name: str)

Update a tenant.

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

Send the request

Options

class pycamunda.tenant.Options(url: str, id_: Optional[str] = None)

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

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

Send the request

Delete

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

Delete a tenant.

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

Send the request