Share:
Developers » Script Objects & Methods » ScriptUser

PREVIOUS  |  NEXT

ScriptUser


The following table lists the available methods for the ScriptUser object:

Return TypeMethodExplanation
StringgetSystemId()Returns the system ID of the user
StringgetName()Returns the full name of the user
StringgetFirstName()Returns the first name of the user
VoidgetMiddleName(String middleName)Returns the middle name of the user
StringgetLastName()
Returns the last name of the user
StringgetLoginName()Returns the login name of the user
StringgetPassword() Returns the password of the user
StringgetEmail()Returns the email address of the user
StringgetDescription()Returns the description of the user
ScriptDepartmentgetDepartment()Returns the department of the user 
ScriptCompanygetCompany()Returns the company of the user
BooleangetActive (Object)  Returns true if the user is active
ScriptUserTypegetUserType()Returns the user type of the user
String getPhotoUrl()Returns the URL of the profile picture of the user 
String getPhotoSmallUrl()Returns the URL of the profile picture (small size) of the user 
String 
getPhotoMediumUrl()Returns the URL of the profile picture (medium size) of the user 
StringgetPhotoBigUrl()  Returns the URL of the profile picture (big size) of the user
Object(string, number, date, etc.) getCustomFieldValue(String customFieldSystemID)Returns the value of the custom field
ScriptCustomField getCustomField(String customFieldSystemID)Returns the custom field of the user 
Boolean isAdmin()Returns true if the user is an administrator 
BooleanisCustomFieldSelectedAll(String customFieldSystemID, Object value)Returns true if one of the selected predefined values in the custom field is the value
Boolean isCustomFieldSelectedAny(String customFieldSystemID, Object value)Returns true if the selected predefined value in the custom field is the value 
VoidsetFirstName(String firstName)  Sets the first name for the user
VoidsetMiddleName(String middleName)  Sets the middle name for the user
Void setLastName(String lastName)Sets the last name for the user 
VoidsetLoginName(String loginName)Sets the login name for the user 
VoidsetPassword(String password)Sets the password for the user 
Void setEmail(String email)Sets the email address for the user 
Void setDescription(String description)Sets the description for the user 
Void setDepartment(ScriptDepartment department)Sets the department for the user 
VoidsetActive(boolean isActive)  Activates or deactivates the user
Void setUserType(ScriptUserType userType)Sets the user type for the user 
VoidsetAdmin(boolean isAdmin)Sets the user to be an administrator, or not
ScriptCustomfieldsetCustomField(String customFieldSystemID, Object value)  Sets the custom field for the user with the object value
VoidsetCustomField(ScriptCustomField customField)  Sets the custom field for the user
Stringresp.users.getUser.getFederationId()

Returns the Federation ID of the user

Federation ID is used for Single Sign On (SSO). For more information, see SAML SSO Integration with Workflow.

Stringresp.users.setUser.getFederationId()
Sets the Federation ID of the user.

Federation ID is used for Single Sign On (SSO). For more information, see SAML SSO Integration with Workflow.