Home > @vsf-enterprise/sap-commerce-webservices-sdk > UsersApi

UsersApi class

UsersApi - object-oriented interface UsersApi {BaseAPI}

Signature:

export declare class UsersApi extends BaseAPI 

Extends: BaseAPI

Methods

Method Modifiers Description
createUser(baseSiteId, user, fields, options) Registers a customer. Requires the following parameters: login, password, firstName, lastName, titleCode. Registers a customer
getUser(baseSiteId, userId, fields, options) Returns customer profile. Get customer profile
getUserCustomerGroups(baseSiteId, userId, fields, options) Returns all customer groups of a customer. Get all customer groups of a customer.
removeUser(baseSiteId, userId, options) Removes customer profile. Delete customer profile.
replaceUser(baseSiteId, userId, user, options) Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default). Updates customer profile
replaceUserLogin(baseSiteId, newLogin, password, userId, options) Changes a customer's login name. Requires the customer's current password. Changes customer's login name.
replaceUserPassword(baseSiteId, _new, userId, old, options) Changes customer's password. Changes customer's password
updateUser(baseSiteId, userId, user, options) Updates customer profile. Only attributes provided in the request body will be changed. Updates customer profile