Identity

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

UsersGroups

class pycamunda.identity.UsersGroups(groups: Tuple[pycamunda.group.Group], group_users: Tuple[pycamunda.user.User])

Data class of the groups of an user and all of their members as returned by the REST api of Camunda.

AuthStatus

class pycamunda.identity.AuthStatus(user_id: str, authenticated: bool)

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

PasswordPolicy

class pycamunda.identity.PasswordPolicy(placeholder: str, parameters: Dict[str, Any])

Data class of the password policy as returned by the REST api of Camunda.

PasswordPolicyCompliance

class pycamunda.identity.PasswordPolicyCompliance(policy: pycamunda.identity.PasswordPolicy, valid: bool)

Data class of the password policy compliance as returned by the REST api of Camunda.

GetGroups

class pycamunda.identity.GetGroups(url: str, user_id: str)

Get the groups of an user and all of their members.

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

Send the request.

VerifyUser

class pycamunda.identity.VerifyUser(url: str, username: str, password: str)

Verify the credentials of an user.

Parameters:
  • url – Camunda Rest engine URL.
  • username – Name of the user.
  • password – Password of the user.
__call__(*args, **kwargs) → pycamunda.identity.AuthStatus

Send the request.

GetPasswordPolicy

class pycamunda.identity.GetPasswordPolicy(url: str)

Get the list of password policy rules.

Parameters:url – Camunda Rest engine URL.
__call__(*args, **kwargs) → Tuple[pycamunda.identity.PasswordPolicy]

Send the request.

ValidatePassword

class pycamunda.identity.ValidatePassword(url: str, password: str)

Validate a password against the password policy rules.

Parameters:
  • url – Camunda Rest engine URL.
  • password – Password to validate.
__call__(*args, **kwargs) → Tuple[pycamunda.identity.PasswordPolicyCompliance]

Send the request.