Interface IAnyUser
- All Known Implementing Classes:
AnyUser
public interface IAnyUser
The Interface IAnyUser to access user's data. User identifier is the user login.
-
Method Summary
Modifier and TypeMethodDescriptionGets the authentication mode.Gets the user custom metadata node.getId()Gets the identifier.getMail()Gets the user mail address.getName()Gets the user name.voidsetApi(boolean api) Sets the API value.voidsetAuthentication(String authentication) Sets the authentication mode.voidsetCreationDate(Date creationDate) Sets the creation date.voidsetDisabled(boolean disable) Sets the disabled value.voidsetExtendedMetadata(ICObject extendedMetadata) sets the user custom metadata .voidsetExternal(boolean external) Sets the external value.voidsetFirstLoginDate(Date firstLoginDate) Sets the first login date.voidsetFreeUser(boolean freeUser) Sets the free user value.voidSets the groups.voidSets the identifier.voidsetLastLoginDate(Date lastLoginDate) Sets the last login date.voidSets the user mail address.voidSets the user name.voidsetPassword(String password) Sets the password.voidsetPasswordExpired(boolean expire) Sets the password expired value.voidsetResetColumns(boolean reset) Set reset columns valuevoidsetResetMFA(boolean reset) Set MFA reset valuevoidSets the roles.voidsetSubscriptionDate(Date subscriptionDate) Sets the subscription date.
-
Method Details
-
getAuthentication
String getAuthentication()Gets the authentication mode. -
getExtendedMetadata
ICObject getExtendedMetadata()Gets the user custom metadata node.- Returns:
- a JSON containing each user custom metadata
-
getId
String getId()Gets the identifier.- Returns:
- the user login identifier
-
getMail
String getMail()Gets the user mail address.- Returns:
- the user mail address
-
getName
String getName()Gets the user name.- Returns:
- the user name
-
setAuthentication
- Parameters:
authentication- the new authentication mode
-
setCreationDate
Sets the creation date.- Parameters:
creationDate- the new creation date
-
setDisabled
void setDisabled(boolean disable) Sets the disabled value.- Parameters:
disable- the new disabled value
-
setExternal
void setExternal(boolean external) Sets the external value.- Parameters:
set- the user as external
-
setApi
void setApi(boolean api) Sets the API value.- Parameters:
set- the user as restricted to API usage
-
setExtendedMetadata
sets the user custom metadata .- Parameters:
a- JSON containing each user custom metadata
-
setFirstLoginDate
Sets the first login date.- Parameters:
firstLoginDate- the new first login date
-
setFreeUser
void setFreeUser(boolean freeUser) Sets the free user value.- Parameters:
freeUser- the new free user value
-
setGroups
Sets the groups.- Parameters:
groups- the new groups
-
setId
Sets the identifier.You must use the user login to identify a user.
- Parameters:
userid- the new identifier
-
setLastLoginDate
Sets the last login date.- Parameters:
lastLoginDate- the new last login date
-
setMail
Sets the user mail address.- Parameters:
mail- the new user mail address
-
setName
Sets the user name.- Parameters:
name- the new user name
-
setPassword
Sets the password.- Parameters:
password- the new password
-
setPasswordExpired
void setPasswordExpired(boolean expire) Sets the password expired value.- Parameters:
expire- the new password expired value
-
setResetColumns
void setResetColumns(boolean reset) Set reset columns value- Parameters:
reset- the reset action
-
setResetMFA
void setResetMFA(boolean reset) Set MFA reset value- Parameters:
reset- the reset action
-
setRoles
Sets the roles.- Parameters:
roles- the new roles
-
setSubscriptionDate
Sets the subscription date.- Parameters:
subscriptionDate- the new subscription date
-