UsersApiFactory
UsersApi - factory interface
Signature
UsersApiFactory: (
configuration?: Configuration,
basePath?: string,
axios?: AxiosInstance
) => {
createUser(baseSiteId: string,
userSignUp: UserSignUp,
fields?: string,
sapCommerceCloudCaptchaToken?: string,
options?: any): AxiosPromise<User>;
getUser(baseSiteId: string,
userId: string,
fields?: string,
options?: any): AxiosPromise<User>;
getUserCustomerGroups(baseSiteId: string,
userId: string,
fields?: string,
options?: any): AxiosPromise<UserGroupList>;
removeUser(baseSiteId: string,
userId: string,
options?: any): AxiosPromise<void>;
replaceUser(baseSiteId: string,
userId: string,
user: User,
options?: any): AxiosPromise<void>;
replaceUserLogin(baseSiteId: string,
newLogin: string,
password: string,
userId: string,
options?: any): AxiosPromise<void>;
replaceUserPassword(baseSiteId: string,
_new: string,
old: string,
userId: string,
options?: any): AxiosPromise<void>;
updateUser(baseSiteId: string,
userId: string,
user: User,
options?: any): AxiosPromise<void>;
}Parameters
| Name | Required | Type | Description |
|---|---|---|---|
configuration | Optional | Configuration | |
basePath | Optional | string | |
axios | Optional | AxiosInstance |
Referenced Types
AxiosInstance- UserSignUp
AxiosPromise- User
- UserGroupList