Supported Bean: UserBean

This bean represents a single user. It has nothing more than what UserEntityBean has. We have it here to keep the symmetric similarity among beans, events and event handlers for user entity, user and group.

Event handler: com.microstrategy.web.beans.EnumEventHandlerTypes.HANDLER_TYPE_USER (65536)

Event handler that can be assoicated with a User Bean.

Events

delete, delete, duplicate, duplicate, initAsNew, initAsNew, modifyAnalysisQuotas, modifyAuthentication, modifyBasicInfo, modifyParents, modifyPrivileges, modifyPrivilegesOnly, modifySecurityFilters, modifySecurityRoles, refresh, refresh, save, save, setName

delete
Event for deleting current user. No parameter.

1048576001

EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_DELETE

delete
Event for deleting current user. No parameter.

32768006

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_DELETE

duplicate
Event for duplicating current user and refrencing to the duplicated user. No parameter.

1048576004

EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_DUPLICATE

duplicate
Event for duplicating current user and refrencing to the duplicated user. No parameter.

32768009

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_DUPLICATE

initAsNew
Event for creating a new user. No parameter.

1048576003

EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_INIT_AS_NEW

parents

Argument ID for parent groups. This argument contains multiple values. One value for each parent. Should contain all parents into this argument. Any current parent missing from this argument means that parent has been removed. For each individual value, it contains the parent DSSID.

32768006

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PARENTS

initAsNew
Event for creating a new user. No parameter.

32768008

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_INIT_AS_NEW

parents

Argument ID for parent groups. This argument contains multiple values. One value for each parent. Should contain all parents into this argument. Any current parent missing from this argument means that parent has been removed. For each individual value, it contains the parent DSSID.

32768006

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PARENTS

modifyAnalysisQuotas
This event indicates the modification on user analysis quota

32768014

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_ANALYSIS_QUOTAS

quotas

Argument ID for quota setting values of all projects for current user

32768011

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_QUOTAS

modifyAuthentication
Event for modifying authentication information of an account. The possible parameters can be sent in are: These parameters are optional, any missing parameter means no change to that part of information. These are common parameters can be sent for both UserBean and UserGroupBean. There may be additonal parameters can be sent. Please check EnumUserBeanEvents and EnumGroupBeanEvents for additional parameters.

32768002

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_AUTH

LDAPDN

Argument ID for LDAPDN. The value for this argument is a String of account's LDAPDN.

32768003

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_LDAPDN

saveNow

Argument ID for saving immediately or not. If saving the account information to Intelligence Server is required after processing the event handling, should include this argument in the event and put the value as EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES. Missing this argument or a value of EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO mean to not save the changed account information back to Intelligence Server. The only exception is security roles. Any changes for security roles will be saved to Intelligence Server immediately.

32768008

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW

SSO

32768010

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SSO

warehouseID

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_AUTH. The value for this argument is a string representing the warehouse user account name.

65536010

EnumUserBeanEvents.USER_EVENT_ARGUMENT_WHID

warehousePwd

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_AUTH. The value for this argument is a string representing the warehouse user account password.

65536011

EnumUserBeanEvents.USER_EVENT_ARGUMENT_WHPWD

windowsLogin

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_AUTH. The value for this argument is a string representing the window's user account name.

65536009

EnumUserBeanEvents.USER_EVENT_ARGUMENT_WINID

modifyBasicInfo
Event for modifying basic information of an account. The possible parameters can be sent in are: These parameters are optional, any missing parameter means no change to that part of information. These are common parameters can be sent for both UserBean and UserGroupBean. There may be additonal parameters can be sent. Please check EnumUserBeanEvents and EnumGroupBeanEvents for additional parameters.

32768001

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC

*loginName

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The value for this argument is a string represents the login name.

65536001

EnumUserBeanEvents.USER_EVENT_ARGUMENT_LOGIN_NAME

description

Argument ID for description. The value for this argument is a String of account's description.

32768002

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_DESC

disable

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The value for this argument is set to EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES to disable the account and EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO to enable the account.

65536007

EnumUserBeanEvents.USER_EVENT_ARGUMENT_DISABLE

fullName

Argument ID for full name. The value for this argument is a String of account's full name.

32768001

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_FULL_NAME

password

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The value for this argument is a string represents the password.

65536002

EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD

passwordAutoExpire

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The possible value for this argument are EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES and EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO to specify that whether the password of this account will be expired automatically.

65536014

EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_AUTO_EXPIRE

passwordConfirmed

Whether there should be password confirmation.

65536012

EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_CONFIRM

passwordExpFrequency

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The value for this argument is a string representing password expiration frequence in day.

65536006

EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_EXPIRATION_FREQ

passwordExpiration

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The value for this argument is a string representing the password expiration date. The date format is in java DateForm.SHORT style and client's display Locale. This parameter carrys the same information as EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_EXPIRATION_DAYS. When both parameters have value other than the existing value on the user, this one will take effect, and EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_EXPIRATION_DAYS will be ignored.

65536005

EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_EXPIRATION

passwordExpirationDays

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The value for this argument is a string representing the password expiration date as number of days from current date. This parameter carrys the same information as EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_EXPIRATION. When both parameters have value other than the existing value on the user, EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_EXPIRATION will take effect, and this one will be ignored.

65536013

EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_EXPIRATION_DAYS

passwordMustChange

65536004

passwordNotModifiable

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The value for this argument EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES for not modifiable and EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO for modifiable.

65536003

EnumUserBeanEvents.USER_EVENT_ARGUMENT_PASSWORD_NOT_MODIFIABLE

saveNow

Argument ID for saving immediately or not. If saving the account information to Intelligence Server is required after processing the event handling, should include this argument in the event and put the value as EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES. Missing this argument or a value of EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO mean to not save the changed account information back to Intelligence Server. The only exception is security roles. Any changes for security roles will be saved to Intelligence Server immediately.

32768008

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW

stdAuthDisable

Additional argument for event EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_BASIC. The value for this argument is set to EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES to disable standard authentication and EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO to not disable standard authentication.

65536008

EnumUserBeanEvents.USER_EVENT_ARGUMENT_STANDARD_AUTH_DISABLE

modifyParents
Event for modifying parent groups information. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all. These are the optional parameter(s):

32768005

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_PARENTS

parents

Argument ID for parent groups. This argument contains multiple values. One value for each parent. Should contain all parents into this argument. Any current parent missing from this argument means that parent has been removed. For each individual value, it contains the parent DSSID.

32768006

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PARENTS

saveNow

Argument ID for saving immediately or not. If saving the account information to Intelligence Server is required after processing the event handling, should include this argument in the event and put the value as EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES. Missing this argument or a value of EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO mean to not save the changed account information back to Intelligence Server. The only exception is security roles. Any changes for security roles will be saved to Intelligence Server immediately.

32768008

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW

modifyPrivileges
Event for modifying privileges and security roles. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all.

32768003

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_PRIVILEGES

privId

32768009

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGE

privilegeCategories

Argument ID for privilege categories. This argument contains multiple values. One value for each privilege category. Each value will contain these information: The prefixed category type, EnumUserEntityBeanEvents.USER_ENTITY_EVENT_PRIVILEGES_CAT_SET (if appears) and each individual privilege type should be separated by EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER. For information about privilege types in a certain category, please refer to PrivilegeCategories.xml. For the meaning of each privilege, please refer to EnumDSSXMLPrivilegeTypes.

32768007

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGES_CATS

saveNow

Argument ID for saving immediately or not. If saving the account information to Intelligence Server is required after processing the event handling, should include this argument in the event and put the value as EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES. Missing this argument or a value of EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO mean to not save the changed account information back to Intelligence Server. The only exception is security roles. Any changes for security roles will be saved to Intelligence Server immediately.

32768008

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW

securityRoles

Argument ID for security roles. This argument contains multiple values. One value for one project. Should contain all projects into this argument. Any project missing from this argument means that there will be no security role set for that project. For each individual value, it contains two pieces of information: project DSSID and security role DSSID. The string representation of each individual value is project DSSID followed by EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER, followed by a list of security role DSSIDs (individual DSSID values are demilited by the EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER).

32768004

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_ROLES

modifyPrivilegesOnly
Event for modifying privileges. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all.

32768011

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_PRIVILEGES_ONLY

privId

32768009

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGE

privilegeCategories

Argument ID for privilege categories. This argument contains multiple values. One value for each privilege category. Each value will contain these information: The prefixed category type, EnumUserEntityBeanEvents.USER_ENTITY_EVENT_PRIVILEGES_CAT_SET (if appears) and each individual privilege type should be separated by EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER. For information about privilege types in a certain category, please refer to PrivilegeCategories.xml. For the meaning of each privilege, please refer to EnumDSSXMLPrivilegeTypes.

32768007

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_PRIVILEGES_CATS

saveNow

Argument ID for saving immediately or not. If saving the account information to Intelligence Server is required after processing the event handling, should include this argument in the event and put the value as EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES. Missing this argument or a value of EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO mean to not save the changed account information back to Intelligence Server. The only exception is security roles. Any changes for security roles will be saved to Intelligence Server immediately.

32768008

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW

modifySecurityFilters
Event for modifying security filters. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all. These are the optional parameter(s):

32768004

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_SECURITY_FILTER

saveNow

Argument ID for saving immediately or not. If saving the account information to Intelligence Server is required after processing the event handling, should include this argument in the event and put the value as EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES. Missing this argument or a value of EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO mean to not save the changed account information back to Intelligence Server. The only exception is security roles. Any changes for security roles will be saved to Intelligence Server immediately.

32768008

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW

securityFilters

Argument ID for security filters. This argument contains multiple values. One value for one project. Should contain all projects into this argument. Any project missing from this argument means that there will be no security filter set for that project. For each individual value, it contains two pieces of information: project DSSID and security filter DSSID. The string representation of each individual value is project DSSID followed by EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER, followed by security filter DSSID.

32768005

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_FILTERS

modifySecurityRoles
Event for modifying security roles. These parameters are REQUIRED for this event. Any parameter missing means to reset that part of information to be not set at all.

32768012

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_MODIFY_SECURITY_ROLES

saveNow

Argument ID for saving immediately or not. If saving the account information to Intelligence Server is required after processing the event handling, should include this argument in the event and put the value as EnumUserEntityBeanEvents.ARGUMENT_VALUE_YES. Missing this argument or a value of EnumUserEntityBeanEvents.ARGUMENT_VALUE_NO mean to not save the changed account information back to Intelligence Server. The only exception is security roles. Any changes for security roles will be saved to Intelligence Server immediately.

32768008

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SAVE_NOW

securityRoles

Argument ID for security roles. This argument contains multiple values. One value for one project. Should contain all projects into this argument. Any project missing from this argument means that there will be no security role set for that project. For each individual value, it contains two pieces of information: project DSSID and security role DSSID. The string representation of each individual value is project DSSID followed by EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER, followed by a list of security role DSSIDs (individual DSSID values are demilited by the EnumUserEntityBeanEvents.ARGUMENT_SUB_VALUE_DELIMITER).

32768004

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_ARGUMENT_SEC_ROLES

refresh
Event for refreshing current user. No parameter.

1048576005

EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_REFRESH

refresh

32768010

save
Event for saving current user. No parameter.

1048576002

EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_SAVE

save
Event for saving current user. No parameter.

32768007

EnumUserEntityBeanEvents.USER_ENTITY_EVENT_SAVE

setName
Event for setting a new name for the object.

1048576006

EnumEditableObjectBeanEvents.EDITABLE_OBJECT_EVENT_SET_NAME

name

1048576001

EnumEditableObjectBeanEvents.EDITABLE_OBJECT_ARGUMENT_NAME


Notes

* denotes required field.