User Management Microservices
  • Dark
    Light
  • PDF

User Management Microservices

  • Dark
    Light
  • PDF

A set of identity governance APIs which help orchestrate and configure the user management process from creation and activation to expiry and deactivation.


APIs

associateAccountWithUser

The purpose of this API is to associate a customer's account with an existing user that is created with the order submission based on the hierarchy ID.

associateIndividualWithUser

The purpose of this API is to associate an individual with an existing user, created with the order submission and associated with the new account ID. This is based on the individual ID.

createUser

The purpose of this API is to create a new user in the Identity Management (IDM) system based on the account internal ID after performing the validation checks. A unique ID is created for every new user. During the creation process, the user details needs to be specified. Once the details are saved, an activation email is sent to the user.

createUserWithoutAccount

The purpose of this API is to create a new user and capture the consents before the cart is checked out without associating it to a customer's account in the case of a new customer acquisition flow.

deactivateassociatedUser

The purpose of this API is to deactivate a user associated with an individual ID. Once the user is deactivated successfully, a message displays on the screen.

deactivateUser

The purpose of this API is to deactivate a new user in the IDM system so that the user can no longer has access to their account or hierarchy via the Self-care UI, based on the relevant input parameters.

deleteAgentScore

The purpose of this API is to remove the existing sales agent hot list details and may be performed by uploading a file.

deleteContactMedium

The purpose of this API is to remove the contact medium information of an existing user from the database. This is required so that the contact information is maintained in the database.

dissociateAccountFromUser

The purpose of this API is to dissociate a customer's account from an existing user based on the relevant input parameters, such as account internal ID and user ID.

executeEmailActions

The purpose of this API is to execute the specified email action types depending on the user ID. The email explains the required action to be executed for the user.

findUsers

The purpose of the findUsers API is to search users in the IDM database after specifying the relevant input parameters, such as customer account or hierarchy ID.

getAdminEvents

The purpose of this API is to retrieve all the admin events or filter events, associated with a user. This request is based on the URL query parameters. This API is called by the Customer Administration Portal user interface.

getUserById

The purpose of this API is to retrieve the details of an existing contact from the IDM based on the relevant input parameters, such as account internal ID and user ID. The return result displays the relevant contact medium ID to the client.

getUsersByIndividualId

The purpose of this API is to retrieve the details of a list of users based on the individual ID. The details should include the contact information, communication address information, payment details, and so on.

groupMembers

The purpose of this API is to filter all the group results, send through based on the filters passed as a query parameter.

postAgentScore

The purpose of this API is to create the a new agent score associated with a score value and a score ID.

resendInvitation

The purpose of this API is to resend the invitation to a user based on the unique user ID. A user initiates the re-sending of an email invitation to activate their existing account with a temporary password.

retrieveCsrUsers

The purpose of this API is to retrieve the list of the CSR users of the CSR realm based on the specified token and filtered according to the query parameters.

retrieveGroupsByUser

The purpose of this API is to retrieve the list of group users filtered according to the query parameters.

retrieveUsersById

The purpose of this API is to find users in the IDM by applying a search criteria on the basis of the user ID. The API should return the attributes on the user, the groups, and the roles associated with the user.

retrieveUsersByIdWithExData

The purpose of this API is to find users with the extended data information in the IDM by applying a search criteria based on the user ID.

searchGroups

The purpose of this API is to filter the result of all the group members based on the search criteria. The groups are filtered with the group name, if no input string was recieved all groups will be returned.

updateContactMediums

The purpose of this API is to update the contact medium information of a user based on the input parameters, such as contact medium and contact medium ID. The contact media types include email, physical mail, text messages, voice calls, Skype, WhatsApp, and so on. A user can specify more than one contact information for a given contact media type, for example, fixed and mobile phone numbers.

updateUser

The purpose of this API is to update a user based on the customer's username. While updating the details, if there are any failures, the API returns the failure description.

updateUserAttributes

The purpose of this API is to update the attributes of a user based on the request received from the user.

updateUserContact

The purpose of this API is to update the contact information of an existing user in the IDM database based on the relevant input parameters, such as account internal ID and user ID. This is required so that the tenant has the updated information to use for communication.

updateUserInformation

The purpose of this API is to update the details of an existing contact in the IDM. The contact information can be communication address, contact number, email address, and so on. This is required so that the tenant has updated information to use for communication purpose.

validateUsername

The purpose of this API is to check if the user already exists in the IDM based on a specific user name. The result of the validate contact must display additional information of account status, tagging, account balance in the a specific format.

Discover how we can help your Business

Get in touch with us today


Was this article helpful?