Users

This is for users who wish to maintain Users, Roles and Organizations.

The bundle provides access to the following TalentLink web services :


Typical workflow

 

Use Case

Users are created in TalentLink directly from the external HRIS.

An administrator activates or deactivates selected users and manages role assignment. This feature speeds up the on-boarding process and makes user management in both systems transparent.

Pre-condition - The user is created in an HRIS.

Scenario

  1. START. The HRIS administrator creates a new user as a part of the new employee onboarding process.
  2. The HRIS generates a file using the predefined file definition schema to exchange data with TalentLink.
  3. The HRIS calls the TalentLink Exchange user web service to create a user in Talentlink.
  4. Web method maps the incoming data to the TalentLink user definition and returns a success or failure message
  5. If TalentLink Exchange successfully manages the request, a new user is created in TalentLink.
  6. If TalentLink Exchange returns an error, an appropriate SOAP response is sent to the web service client (for SOAP web services).

The same scenario applies to user activation.

The next step would be role assignment. To make it faster, role tags can be used. For further details refer to Role API Calls.

Response Format

XML

SOAP METHODS

 

The method activateUser is used to enable user account within the Lumesse BackOffice. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
id
Long
ID is the internal auto generated user of the Talentlink BackOffice system

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
Method addTag is used to add tag of type to user. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360
tagName
String
[mandatory] Name of tag
tagTypeName
String
[mandatory] Name of tag type

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The assignRole method of the User web service consists of User ID, Role ID and a collections Departments. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360
roleId
Long
[mandatory] This is the ID of the role the user will be assigned to eg: 111
departmentIdList
String
[mandatory] This will be ID produced from the role being assigned to the Department eg: 313

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The assignRoles method requires that one of user parameters is not empty (userId or login or email) and either roleIds or roleNames is not empty. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
This is the ID of the user in the BackOffice eg: 1360
login
String
This is the login of the user in the BackOffice eg: a.smith
email
String
This is the email of the user in the BackOffice eg: a.smith@company.com
roleId
List
This is the role ID of the user in the BackOffice eg: 7
roleName
List
This is the role name of the user in the BackOffice eg: 7
departmentId
Long
This is the departmentId related to the role ids

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The method assignRolesWithTag should be used when all roles need to be tagged to reflect what was done in assignRole method, for example id we created the Role for 'Reporter' (potentially this can be any other function identified). This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360
tagName
String
[mandatory] As mentioned if assignRole method and the Role is for example 'Reporter'
tagTypeName
String
[mandatory] Client Name(User Function)
departmentIdList
String
[mandatory] This will be ID produced from the role being assigned to the Department eg: 313

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The changePassword method can be used to set new password for provided user. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
id
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360
password
String
[mandatory] New password for user

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The clearAllRoleAssignments method removes assigned roles to users This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The configureUser method can be used to set additional configuration items for user. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
id
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360
configuration
List
List of custom config items
  name
UserConfigParams
Name of the configuration item Possible values: NOTIFICATION_INTERVAL, NOTIFICATION_STATUS, DISABLE_LOGIN_PAGE, ALERT_CANDIDATE, ALERT_MESSAGE, ALERT_TIMESHEETS, MESSAGE_FORMAT available message format true - plainText, false - html, available alerts values true/false
  value
String
Value of the configuration item

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The createUser method of the User web service accepts parameters of a User and an activationType. If the call is successful, the ID of the newly created user is returned. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
user
UserExtDto
[mandatory] Represents data of the created user.
  password
String
Password set for User in the Backoffice for Lumesse
  language
LangCode
Defines language of user. Possible values: Click to see possible values
  dateFormat
String
Define date format used by user. Possible values: Click to see possible values
  timeFormat
String
Defines time format used by user. Possible values 12h or 24h
  timeZone
String
Country timezone (TimeZone represents a time zone offset, and also figures out daylight savings.) possible values:\ Click to see possible values
  firstDayOfWeek
DayOfWeek
Monday - Sunday If not specified defaults are applied (Sunday if date format is mm/dd/yyyy otherwise its Monday by default)
  passwordType
PasswordType
SYSTEM or CUSTOM If the passwordType is set to SYSTEM(default), a user trying to login manually or using SSO is prompted to reset the password. If the passwordType is set to CUSTOM, a user trying to login manually or using SSO is not prompted to reset the password and can login immediately.
  recruitmentRole
String
Recruitment Role is used to determine the business role of the system user. Possible values: HeadOfHrOrVpOfHr, HeadOfTalentAcquisitionOrRecruitmentManager, RpoAccountManagerOrDirector, HrAdministratorOrHrGeneralist, HiringManagerOrLineManager, RecruiterOrResourcer, TalentLinkSystemAdministrator, Other
  otherRecruitmentRole
String
Use this value when Other was selected as Recruitment Role
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active
activationType
String
[mandatory] Represents activation type. Possible values SENDACTIVATIONREQUESTTOEMAIL ACTIVATEUSERLATER ACTIVATEUSERNOWANDSENDEMAILNOTIFICATION ACTIVATEUSERNOWWITHOUTSENDINGEMAILNOTIFICATION

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
user
UserExtDto
Represents data of the created user.
  password
String
Password set for User in the Backoffice for Lumesse
  language
LangCode
Defines language of user. Possible values: Click to see possible values
  dateFormat
String
Define date format used by user. Possible values: Click to see possible values
  timeFormat
String
Defines time format used by user. Possible values 12h or 24h
  timeZone
String
Country timezone (TimeZone represents a time zone offset, and also figures out daylight savings.) possible values:\ Click to see possible values
  firstDayOfWeek
DayOfWeek
Monday - Sunday If not specified defaults are applied (Sunday if date format is mm/dd/yyyy otherwise its Monday by default)
  passwordType
PasswordType
SYSTEM or CUSTOM If the passwordType is set to SYSTEM(default), a user trying to login manually or using SSO is prompted to reset the password. If the passwordType is set to CUSTOM, a user trying to login manually or using SSO is not prompted to reset the password and can login immediately.
  recruitmentRole
String
Recruitment Role is used to determine the business role of the system user. Possible values: HeadOfHrOrVpOfHr, HeadOfTalentAcquisitionOrRecruitmentManager, RpoAccountManagerOrDirector, HrAdministratorOrHrGeneralist, HiringManagerOrLineManager, RecruiterOrResourcer, TalentLinkSystemAdministrator, Other
  otherRecruitmentRole
String
Use this value when Other was selected as Recruitment Role
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active
The method deactivateUser is used to disable user account within the Lumesse BackOffice. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
id
Long
ID is the internal auto generated user of the Talentlink BackOffice system

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The deleteRoles method requires that one of user parameters is not empty (userId or login or email) and either roleIds or roleNames is not empty. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
This is the ID of the user in the BackOffice eg: 1360
login
String
This is the login of the user in the BackOffice eg: a.smith
email
String
This is the email of the user in the BackOffice eg: a.smith@company.com
roleId
List
This is the role ID of the user in the BackOffice eg: 7
roleName
List
This is the role name of the user in the BackOffice eg: 7
departmentId
Long
This is the departmentId related to the role ids

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The deleteUser method removes user from talentlink. This method must be called with Talentlink backoffice user credentials. Only one of parameters needs to by provided. Method first check if user with given userId exists if not it try to find user by userLogin.

Post Parameter

 
Parameter Data Type Description
userId
Long
- id of user to delete
userLogin
String
- login of user to delete

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The generatePassword is a tool method that can be used to generate secure password.

Post Parameter

 
Parameter Data Type Description

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
generatedPassword
String
Generated password
The generateTemporaryPassword method generates a temporary password to access the Lumesse BackOffice. To have this generated, you require the User Login to be sent and the response will be a temporary password. Once this has been used to login, you will be prompted and directed to a page within the Lumesse BackOffice to enter a new and memorable password. Please note that this is only valid temporary for 120min. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userLogin
String
User Login Id is the login id of the Talentlink BackOffice user

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
string
String
Auto generated password from the system this can be used to login to the Lumesse BackOffice and then you will be prompted to change to a new password. Please note that this is only valid temporary for 120min.
The method getCurrentUserExt is used to retrieve a data of authenticated user within the Lumesse BackOffice system. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
user
UserExtDto
Current user data
  password
String
Password set for User in the Backoffice for Lumesse
  language
LangCode
Defines language of user. Possible values: Click to see possible values
  dateFormat
String
Define date format used by user. Possible values: Click to see possible values
  timeFormat
String
Defines time format used by user. Possible values 12h or 24h
  timeZone
String
Country timezone (TimeZone represents a time zone offset, and also figures out daylight savings.) possible values:\ Click to see possible values
  firstDayOfWeek
DayOfWeek
Monday - Sunday If not specified defaults are applied (Sunday if date format is mm/dd/yyyy otherwise its Monday by default)
  passwordType
PasswordType
SYSTEM or CUSTOM If the passwordType is set to SYSTEM(default), a user trying to login manually or using SSO is prompted to reset the password. If the passwordType is set to CUSTOM, a user trying to login manually or using SSO is not prompted to reset the password and can login immediately.
  recruitmentRole
String
Recruitment Role is used to determine the business role of the system user. Possible values: HeadOfHrOrVpOfHr, HeadOfTalentAcquisitionOrRecruitmentManager, RpoAccountManagerOrDirector, HrAdministratorOrHrGeneralist, HiringManagerOrLineManager, RecruiterOrResourcer, TalentLinkSystemAdministrator, Other
  otherRecruitmentRole
String
Use this value when Other was selected as Recruitment Role
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active
The getGrantedPools can be used to retrieve list of granted pools for currently logged user. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
user
String
List of pairs representing granted pools
This method returns a list of Lumesse BackOffice system users ordered by user last name wich have their account inactivated. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
user
List
List of user data
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active
The getPasswordRules method returns password rules. This method must be called with Talentlink backoffice user credentials.

Post Parameter

 
Parameter Data Type Description
langCode
LangCode
- Language in which password rule description is returned. EN is default.

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
passwordRules
List
List of password rules
  code
PasswordRuleCode
Password rule code.
  description
String
Password rule description that is translated according to langCode.
  parameter
String
Value that "supports" password rule e.g. MinimumLength parameter can be "8" - so password must have at least 8 characters.
  toRemove
Boolean
The getRightsForDepartmentAndCurrentUser method is used to return the list of rights for current user in department This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!" .

Post Parameter

 
Parameter Data Type Description
departmentId
Long
[mandatory] This is the ID of the department in the BackOffice eg: 8

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
rights
List
Right ID assigned to the current user in department
The getRightsWithLabels method is used to return the list of rights with corresponding label for current user in passed department This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!" .

Post Parameter

 
Parameter Data Type Description
departmentId
Long
[mandatory] This is the ID of the department in the BackOffice eg: 8

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
rights
List
List of rights IDs and its label assigned to the current user in department
  rightId
Long
  rightLabel
String
The getRolesAssignedForUser method is used to return the list of role assignments for given user. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
userRoleAssignment
Collection
Represents all role assignments for user
  organization
OrganizationDto
Organization in which role is assigned
    unit
Unit
Returns list of organizations to which the position belongs. Each organization consists of code, id, level and name. If non default constructor is used to create Organization object, list will contain organization for which opening was created and its all higher level organizations. Example of data sent in response: <organization> <unit level="1" id="151">First level organization.</unit> <unit level="2" id="222">Parent organization for organization on level 3.</unit> <unit level="3" id="248">Organization related with opening, level 3.</unit> </organization>
      name
String
Returns name of organization as a xml tag value.
      level
Integer
Returns organization's level.
      id
Long
Returns organization's id.
      code
String
Organization code.
      nameTranslation
String
Translation of the organization name (if defined in BO).
  role
RoleDto
Represents role which is assigned to user
    id
Long
Id of the role
    name
String
Name of the role assigned to
    type
String
Type of current role for example (HIRING MANAGER, RECRUITER, BASIC ACCESS.. etc)
    updateDate
Date
Last update date
    tags
List
List of tags assigned to role
      tag
BasicTagDto
Tag assigned to role
        labelKey
String
[optional] Tag label
        name
String
Tag name
        type
TagTypeDto
Tag type
          labelKey
String
[optional] Tag type label
          name
String
Tag type name
  beginDate
Date
When user is assigned to the role
  endDate
Date
When the assignment to role expires
  creationDate
Date
When user is assigned and user is created with that role
  nameTranslation
String
Translated role assignment name
Method getTagTypes is used to get all possible tag types. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
type
Collection
Tag Type list
  labelKey
String
[optional] Tag type label
  name
String
Tag type name
Method getTaggedUsers is used to return list of users that are assigned to tag. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
tagName
String
Name of tag
tagTypeName
String
Name of tag type

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
user
Collection
List of user data
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active
Method getTagsForType is used to return list of possible tags for given type. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
tagTypeName
String
[mandatory] Name of tag type

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
tag
Collection
List of tags
  labelKey
String
[optional] Tag label
  name
String
Tag name
  type
TagTypeDto
Tag type
    labelKey
String
[optional] Tag type label
    name
String
Tag type name
The method getUserById is used to retrieve a user with a specified ID within the Lumesse BackOffice system. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
id
Long
ID is the internal auto generated user of the Talentlink BackOffice system

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
user
UserDto
User data
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active
The method getUserData is used to retrieve custom user data for user with a specified ID within the Lumesse BackOffice system. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
ID is the internal auto generated user of the Talentlink BackOffice system

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
userData
List
List of custom user data
  name
String
User data entry name
  value
String
User data entry value
  parentValue
String
User data parent entry value
  parentName
String
User data parent entry name
The method getUserExtById is used to retrieve a user with a specified ID within the Lumesse BackOffice system. It is similar to getUserById but it returns more data. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
id
Long
ID is the internal auto generated user of the Talentlink BackOffice system

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
user
UserExtDto
User data
  password
String
Password set for User in the Backoffice for Lumesse
  language
LangCode
Defines language of user. Possible values: Click to see possible values
  dateFormat
String
Define date format used by user. Possible values: Click to see possible values
  timeFormat
String
Defines time format used by user. Possible values 12h or 24h
  timeZone
String
Country timezone (TimeZone represents a time zone offset, and also figures out daylight savings.) possible values:\ Click to see possible values
  firstDayOfWeek
DayOfWeek
Monday - Sunday If not specified defaults are applied (Sunday if date format is mm/dd/yyyy otherwise its Monday by default)
  passwordType
PasswordType
SYSTEM or CUSTOM If the passwordType is set to SYSTEM(default), a user trying to login manually or using SSO is prompted to reset the password. If the passwordType is set to CUSTOM, a user trying to login manually or using SSO is not prompted to reset the password and can login immediately.
  recruitmentRole
String
Recruitment Role is used to determine the business role of the system user. Possible values: HeadOfHrOrVpOfHr, HeadOfTalentAcquisitionOrRecruitmentManager, RpoAccountManagerOrDirector, HrAdministratorOrHrGeneralist, HiringManagerOrLineManager, RecruiterOrResourcer, TalentLinkSystemAdministrator, Other
  otherRecruitmentRole
String
Use this value when Other was selected as Recruitment Role
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active
This method returns a list of Lumesse BackOffice system ordered by user last name. Note: Response only returns users that match following criteria 1. NOT Archived 2. password type with 'SYSTEM' and 'CUSTOM' This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
requestByGetUsersDto
RequestByGetUsersDto
Details about searching user/s.
  email
String
Email of the user
  firstName
String
First Name of the user
  lastName
String
Last Name of the user
  organizationId
Long
Organisation Id where user has at least one role
  pageNumber
Int
Number of the results page
  userId
Long
Id of the user
  login
String
Login of the user
  userStatus
UserStatus
User status. Possible values ACTIVE, INACTIVE, ALL

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
user
List
List of user data
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active
The removeFederationData method removes federation data for user This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The removeRoleAssignment method can be used to remove role assignment. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360
roleId
Long
[mandatory] This is the ID of the role the user will be assigned to eg: 111
departmentIdList
String
[mandatory] This will be ID produced from the role being assigned to the Department eg: 313

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The removeRolesWithTag method can be used to remove roles that contain a tag. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360
tagName
String
[mandatory] As mentioned if assignRole method and the Role is for example 'Reporter'
tagTypeName
String
[mandatory] Client Name(User Function)
departmentIdList
String
[mandatory] This will be ID produced from the role being assigned to the Department eg: 313

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
Method removeTag is used to remove tag of type from user. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
userId
Long
[mandatory] This is the ID of the user in the BackOffice eg: 1360
tagName
String
[mandatory] Name of tag
tagTypeName
String
[mandatory] Name of tag type

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void
The updatePasswordRules method updates existing password rules of the account. Provided list of rules replace existing one if it pass validation. This method must be called with Talentlink backoffice user credentials.

Post Parameter

 
Parameter Data Type Description
passwordRules
List
New password rules
  code
PasswordRuleCode
Password rule code.
  description
String
Password rule description that is translated according to langCode.
  parameter
String
Value that "supports" password rule e.g. MinimumLength parameter can be "8" - so password must have at least 8 characters.
  toRemove
Boolean

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
passwordRuleValidation
List
List of validation messages
  code
PasswordRuleCode
  message
String
The method updateUser is used to make changes and update users within the Lumesse BackOffice system. This method must be called with Talentlink backoffice user credentials. The user name must be set to the following format: CompanyName:saif:BO. The password must be the user password for example: "Saif123!"

Post Parameter

 
Parameter Data Type Description
user
UserExtDto
Represents data of the user which is to be updated.
  password
String
Password set for User in the Backoffice for Lumesse
  language
LangCode
Defines language of user. Possible values: Click to see possible values
  dateFormat
String
Define date format used by user. Possible values: Click to see possible values
  timeFormat
String
Defines time format used by user. Possible values 12h or 24h
  timeZone
String
Country timezone (TimeZone represents a time zone offset, and also figures out daylight savings.) possible values:\ Click to see possible values
  firstDayOfWeek
DayOfWeek
Monday - Sunday If not specified defaults are applied (Sunday if date format is mm/dd/yyyy otherwise its Monday by default)
  passwordType
PasswordType
SYSTEM or CUSTOM If the passwordType is set to SYSTEM(default), a user trying to login manually or using SSO is prompted to reset the password. If the passwordType is set to CUSTOM, a user trying to login manually or using SSO is not prompted to reset the password and can login immediately.
  recruitmentRole
String
Recruitment Role is used to determine the business role of the system user. Possible values: HeadOfHrOrVpOfHr, HeadOfTalentAcquisitionOrRecruitmentManager, RpoAccountManagerOrDirector, HrAdministratorOrHrGeneralist, HiringManagerOrLineManager, RecruiterOrResourcer, TalentLinkSystemAdministrator, Other
  otherRecruitmentRole
String
Use this value when Other was selected as Recruitment Role
  id
Long
ID is the internal auto generated user of the Talentlink BackOffice system
  firstName
String
First name of user for in BackOffice, for example, Saif
  lastName
String
Last name of user, for example, Anjary
  login
String
Login username to access the Lumesse BackOffice
  email
String
Email of the user in the Lumesse BackOffice.
  cellphone
String
Cellphone number of the user
  type
String
ADVANCED = HR recruiter MSS = line manager
  active
Boolean
IF true user is active

Request Parameter

 
Parameter Data Type Description
APi Key Alphanumeric Will be provided by Lumesse

Response Parameter

 
Parameter Data Type Description
void
Void