User

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

User

class pycamunda.user.User(id_: str, first_name: str, last_name: str, email: Optional[str] = None)

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

display_name = None
email = None

Delete

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

Deletes a user by id.

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

Send the request

Count

class pycamunda.user.Count(url: str, id_: Optional[str] = None, first_name: Optional[str] = None, first_name_like: Optional[str] = None, last_name: Optional[str] = None, last_name_like: Optional[str] = None, email: Optional[str] = None, email_like: Optional[str] = None, member_of_group: Optional[str] = None, member_of_tenant: Optional[str] = None)

Count users.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the user.
  • first_name – Filter by the first name of the user.
  • first_name_like – Filter by a substring of the first name.
  • last_name – Filter by the last name of the user.
  • last_name_like – Filter by a substring of the last name.
  • email – Filter by the email of the user.
  • email_like – Filter by a substring of the email.
  • member_of_group – Filter for users which are a member of a group.
  • member_of_tenant – Filter for users which are a member of a tenant.
__call__(*args, **kwargs) → int

Send the request

GetList

class pycamunda.user.GetList(url: str, id_: Optional[str] = None, first_name: Optional[str] = None, first_name_like: Optional[str] = None, last_name: Optional[str] = None, last_name_like: Optional[str] = None, email: Optional[str] = None, email_like: Optional[str] = None, member_of_group: 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)

Query for a list of users using a list of parameters. The size of the result set can be retrieved by using the Get User Count method.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the user.
  • first_name – Filter by the first name of the user.
  • first_name_like – Filter by a substring of the first name.
  • last_name – Filter by the last name of the user.
  • last_name_like – Filter by a substring of the last name.
  • email – Filter by the email of the user.
  • email_like – Filter by a substring of the email.
  • member_of_group – Filter for users which are a member of a group.
  • member_of_tenant – Filter for users which are a member of a tenant.
  • sort_by – Sort the results by id_, first_name, last_name or email of the user.
  • 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.user.User]

Send the request

GetProfile

class pycamunda.user.GetProfile(url: str, id_: str)

Get the profile of an user.

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

Send the request

Options

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

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

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

Send the request

Create

class pycamunda.user.Create(url: str, id_: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, email: Optional[str] = None, password: Optional[str] = None)

Create a new user.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the user.
  • first_name – First name of the user.
  • last_name – Last name of the user.
  • email – Email of the user.
  • password – Password of the user.
__call__(*args, **kwargs) → None

Send the request

UpdateCredentials

class pycamunda.user.UpdateCredentials(url: str, id_: str, password: str, authenticated_user_password: str)

Update a user’s credentials (password).

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the user.
  • password – New password of the user.
  • authenticated_user_password – Password of the authenticated user who changes the password.
__call__(*args, **kwargs) → None

Send the request

UpdateProfile

class pycamunda.user.UpdateProfile(url: str, id_: str, new_user_id: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, email: Optional[str] = None)

Update the profile information of an already existing user.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the user.
  • new_user_id – New user id of the user.
  • first_name – New first name of the user.
  • last_name – New last name of the user.
  • email – New email of the user.
__call__(*args, **kwargs) → None

Send the request

Unlock

class pycamunda.user.Unlock(url: str, id_: Optional[str] = None)

Unlock an user.

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

Send the request