Package org.bonitasoft.engine.identity

Manages information about an organization, that is, the set of users who can act in processes and the groups and the organization's roles and the relation between them.

See: Description

Interface Summary

Interface	Description
ContactData	represents a user contact data
CustomUserInfoDefinition	Describes a custom user information definition that will be available for all Users in the organization.
CustomUserInfoValue	A CustomUserInfoValue defines the value of a CustomUserInfoDefinition for a given User
Group	Represents a group inside the organization.
Icon	an icon that can be attached to a user, group, role.
Role	Represents a role inside the organization.
User	Represents a user inside the organization.
UserMembership	represents a relation between User and Role and Group inside the organization.
UserWithContactData	represents an association of a User and its ContactData

Class Summary

Class	Description
ContactDataCreator	Represents a helper for creating ContactData.
ContactDataUpdater	represents a helper for updating a ContactData
CustomUserInfo	Aggregate information of CustomUserInfoDefinition and CustomUserInfoValue
CustomUserInfoDefinitionCreator	represents a helper for creating a CustomUserInfoDefinition.
CustomUserInfoValueSearchDescriptor	Defines the fields that can be used as filters and soring by CustomUserInfoAPI.searchCustomUserInfoValues(org.bonitasoft.engine.search.SearchOptions).
CustomUserInfoValueUpdater	represents a helper for updating CustomUserInfoValue
GroupCreator	represent a helper for creating a Group
GroupSearchDescriptor	holds constants about Group search filters
GroupUpdater	represent a helper fpr updating a Group
RoleCreator	represents a helper for creating a Role.
RoleSearchDescriptor	holds constants about Role search filters.
RoleUpdater	represents a helper for updating a Role.
UserCreator	represents a helper for creating User.
UserSearchDescriptor	holds constants about User search filters.
UserUpdater	represents a helper for updating a User.

Enum Summary

Enum	Description
ContactDataCreator.ContactDataField	Represents the available ContactData fields
ContactDataUpdater.ContactDataField	The available contact fields
GroupCreator.GroupField	represents the available Group field
GroupCriterion	represents group criterion sort orders
GroupUpdater.GroupField	represents the available Group fields
ImportPolicy	Define how to handle conflicts when an organization is imported.
MemberType	lists the membership types
RoleCreator.RoleField	represents the available Role field
RoleCriterion	list the available Role sort orders
RoleUpdater.RoleField	represent the available Role fields
UserCreator.UserField	represents the available User field
UserCriterion	lists the available User sort orders
UserMembershipCriterion	lists the available User sort orders
UserUpdater.UserField	represent the available User fields

Exception Summary

Exception	Description
GroupNotFoundException	thrown when a Group is not found in the organization
InvalidOrganizationFileFormatException	thrown to indicate an organization import error caused by a parsing error
MembershipNotFoundException	thrown when a UserMembership is not found
OrganizationExportException	thrown to indicate an organization export error
OrganizationImportException	thrown to indicate an organization import error
RoleNotFoundException	thrown when a Role is not found in organization
UserNotFoundException	thrown when a User is not found in the organization

Package org.bonitasoft.engine.identity Description

Manages information about an organization, that is, the set of users who can act in processes and the groups and the organization's roles and the relation between them.

Contains helpers to create and updates organization's groups, roles, users and memberships

Since:

6.0.0

See Also:

Group, Role, User, UserMembership