Users Service API
- UsersService
- Parameters
- messages
- getUserById
- Parameters
- Examples
- requestAuthenticatedUserInformation
- Parameters
- Examples
- getListOfUsersAuthClient
- Parameters
- Examples
- linkAuthClientToUser
- Parameters
- Examples
- requestAuthClientInformation
- Parameters
- Examples
- unlinkAuthClientFromUser
- Parameters
- Examples
- getCitiesByIpAddresses
- Parameters
- Examples
- getCitiesByZipAndCountryCode
- Parameters
- Examples
- getCitiesByZipCodes
- Parameters
- Examples
- getCityByIpAddress
- Parameters
- Examples
- getListOfCountries
- Examples
- getListOfSegmentOptions
- Examples
- getListOfSegments
- Examples
- getListOfStateProvinces
- Examples
- addNewUser
- Parameters
- Examples
- confirmEmail
- Parameters
- Examples
- getLinkForAvatarUpload
- Parameters
- Examples
- getListOfUsers
- Parameters
- Examples
- getPaginationMetadata
- Parameters
- Examples
- getSegmentOptionForUserByToken
- Parameters
- Examples
- getSegmentOptionByUserId
- Parameters
- Examples
- refreshToken
- Parameters
- Examples
- loginProfile
- Parameters
- Examples
- modifyAuthorizedUserInformation
- Parameters
- Examples
- modifyUserInformationByUserId
- Parameters
- Examples
- registerConfirmedUser
- Parameters
- Examples
- requestUserEmailExistInformation
- Parameters
- Examples
- requestUserInformationByUserId
- Parameters
- Examples
- requestChangeEmail
- Parameters
- Examples
- requestChangePasswordEmail
- Parameters
- Examples
- requestForPasswordResetEmail
- Parameters
- Examples
- requestForRegistrationEmail
- Parameters
- Examples
- requestPublicUsersInformation
- Parameters
- Examples
- setNewEmailUsingEmailToken
- Parameters
- Examples
- setNewPasswordToUserUsingChangePasswordToken
- Parameters
- Examples
- setNewPasswordByResetToken
- Parameters
- Examples
- setSegmentOptionByToken
- Parameters
- Examples
- setSegmentOptionByUserId
- Parameters
- Examples
- signinSignupViaAuthClient
- Parameters
- Examples
- subscribeUserToNewsletters
- Parameters
- Examples
- requestUserTokenInformation
- Parameters
- Examples
- getPublicUsersCount
- Parameters
- Examples
- user
- Properties
- See:
Users Micro Service API
- url string service url
- token (string | null) user access tocken if available (optional, default null)
Object with class service messages
Type: object
User - Request public user information by user id
#### Parameters
- userId number User ID
#### Examples
_Get user profile by Id_
``javascript`
(async () => {
const users = new UsersService('//api.templatemonsterdev.com/users/v1/');
const profile = await users.getUserById(1);
})();
Returns user User profile
Request authenticated user information
#### Parameters
- data object any expand
#### Examples
_Get current user profile_
`javascript`
(async () => {
const users = new UsersService('//api.templatemonsterdev.com/users/v1/');
const profile = await users.getProfile(true);
})();
Returns user Current user profile
AuthClient - Get list of users AuthClient
#### Parameters
- params Object params.userId
- number ID of userparams.page
- number Page number
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.getListOfUsersAuthClient({
userId: 12940,
page: 1,
});
})();
Returns Promise<listOfUsers>
AuthClient - Link AuthClient to user
#### Parameters
- params Object params.userId
- String users id in AuthClient.params.client
- String AuthClient name(facebook, google etc.).
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.linkAuthClientToUser({
userId: '12940',
client: 'John',
});
})();
Returns Promise<userInfo>
AuthClient - Request AuthClient information
#### Parameters
- id Number users id in AuthClient.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.requestAuthClientInformation(12940);
})();
Returns Promise<userInfo>
AuthClient - Unlink AuthClient from user
#### Parameters
- params object params.id
- Number users AuthClient unique ID.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.unlinkAuthClientFromUser(params);
})();
Returns Boolean
Cities - Get cities by ip addresses
#### Parameters
- ips array IP addresses.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getCitiesByIpAddresses(["192.168.2.59"]);
})();
Returns Promise<cityInfo>
Cities - Get cities by zip and country code
#### Parameters
- zip String Zip code.zip
- countryCode Country code (2 chars, optional).
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getCitiesByZipAndCountryCode({zip:'02070'});
})();
Returns Promise<cityInfo>
Cities - Get cities by zip codes
#### Parameters
- zips array Zip codes.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getCitiesByZipCodes(["54000"]);
})();
Returns Promise<cityInfo>
Cities - Get city by ip address
#### Parameters
- ip String IP address.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getCityByIpAddress('192.168.2.59');
})();
Returns Promise<cityInfo>
Countries - Get list of countries
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getListOfCountries();
})();
Returns Promise<countriesInfo>
SegmentOptions - Get list of segment options
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getListOfSegmentOptions();
})();
Returns Promise<segmentOptionsInfo>
Segments - Get list of segments
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getListOfSegments();
})();
Returns Promise<segmentOptionsInfo>
StateProvinces - Get list of state provinces
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getListOfStateProvinces();
})();
Returns Promise<segmentOptionsInfo>
User - Add new user
#### Parameters
- params object params.login
- String User loginparams.password
- String User passwordparams.subscription
- Boolean Subscribe user to newsletterparams.locale
- String 2 char locale (if not specified default 'en' will be used)params.country
- String Country code (2 chars)params.state
- String State code (2 chars)params.segmentoptionId
- Number Subscription segment option (if not specified default 4 will be used)
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.addNewUser({
login: 'qweqwe@qwe.qwe',
password: 'qweqwe',
segmentoption_id: 4
});
})();
Returns Promise<userInfo>
User - Confirm email
#### Parameters
- params object params.token
- String User confirm email token.params.scope
- String List of oauth scopes divided by space (optional).
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.confirmEmail(params);
})();
Returns Promise<userInfo>
User - Get link for avatar upload
#### Parameters
- params object params.file
- String Avatar file name.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.getLinkForAvatarUpload(params);
})();
Returns Promise<imageLink>
User - Get list of users
#### Parameters
- params object params.page
- Number Page number.params.perPage
- Number Number of users in one page.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.getListOfUsers(params);
})();
Returns Promise<imageLink>
User - Get pagination metadata for Users {get} /users api call
#### Parameters
- params object params.id
- Number users AuthClient unique ID.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getPaginationMetadata();
})();
Returns Promise<paginationData>
User - Get segment option for user identified by access token
#### Parameters
- params object params.segmentId
- Number Segment ID.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.getSegmentOptionForUserByToken(params);
})();
Returns Promise<userInfo>
User - Get segment option for user identified by user id
#### Parameters
- params object params.userId
- Number User ID.params.segmentId
- Number Segment ID.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.getSegmentOptionByUserId(params);
})();
Returns Promise<userInfo>
User - Issue access token using refresh token
#### Parameters
- params object params.refreshToken
- String Refresh token.params.scope
- String Set of scopes divided by space symbol.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.refreshToken(params);
})();
Returns Promise<userInfo>
User - Issue access token
#### Parameters
- params object params.login
- string user emailparams.password
- string user passwordparams.scope
- string user scopes
#### Examples
_Request Issue access token_
`javascript`
(async () => {
const users = new UsersService('//api.templatemonsterdev.com/users/v1/');
const tokenInfo = await users.loginProfile({
login: 'test@test.com',
password: '123123',
scope: 'memberships,services'
});
})();
Returns object User token information
User - Modify authorized user information
#### Parameters
- params object params.password
- String User password.params.firstname
- String User first name.params.lastname
- String User last name.params.phone
- String User phone.params.avatar
- String User avatar.params.billingInfo
- Array Billing info array with following fields [firstname, lastname, city, email, postalcode, billingphone, country, state, contactphone, address]
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.modifyAuthorizedUserInformation(params);
})();
Returns Promise<userInfo>
User - Modify user information by user id
#### Parameters
- params object params.userId
- Number User unique ID.params.firstname
- String User first name.params.lastname
- String User last name.params.phone
- String User phone.params.stateId
- Number User status ID: 1 - Waiting, 2 - Normal, 3 - Disabled, 4 - Without confirm, 5 - With confirm, 6 - Required confirmparams.billingInfo
- Array Billing info array with following fields [firstname, lastname, city, email, postalcode, billingphone, country, state, contactphone, address]
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.modifyUserInformationByUserId(params);
})();
Returns Promise<userInfo>
User - Register confirmed user
#### Parameters
- params object params.login
- String User login.params.password
- String User password.params.country
- String 2 symbol code of countryparams.state
- String 2 symbol code of state (XX if there are no states in this country)params.firstname
- String params.lastname
- String params.birthday
- Number params.phone
- String params.website
- String params.company
- String params.avatar
- String params.sex
- Number params.expand
- String List of additional data to be returned, may contain following fields divided by comma - billingInfo, segmentOptions, token(this will create new access token), optional.params.sendEmail
- Boolean Flag that indicates if registration email should be sent, optional.params.segmentOptionId
- Number Id of segment option, optional.params.scope
- String List of oauth scopes divided by space.params.billingInfo
- Array User billing info, optional.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.registerConfirmedUser(params);
})();
Returns Promise<userInfo>
User - Request User email exist information
#### Parameters
- params object params.email
- String User email. (required)params.expand
- String List of additional data to be returned (e.g. authClients) (optional).
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.requestUserEmailExistInformation(params);
})();
Returns Promise<userInfo>
User - Request User information by user id
#### Parameters
- params object params.userId
- String User unique ID.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.requestUserInformationByUserId(params);
})();
Returns Promise<userInfo>
User - Request change email
#### Parameters
- params object params.email
- String User email.params.locale
- String email language. (optional, 'en' by default)
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.requestChangeEmail(params);
})();
Returns Boolean
User - Request change password email
#### Parameters
- params object params.email
- String User email.params.password
- String New password to set.params.locale
- String email language. (optional, 'en' by default)
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.requestChangePasswordEmail(params);
})();
Returns Boolean
User - Request for password reset email
#### Parameters
- params object params.email
- String User email.params.locale
- String email language. (optional, 'en' by default)
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.requestForPasswordResetEmail(params);
})();
Returns Boolean
User - Request for registration email
#### Parameters
- params object params.email
- String User email.params.locale
- String email language. (optional, 'en' by default)
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.requestForRegistrationEmail(params);
})();
Returns Boolean
User - Request public users information based on request params
#### Parameters
- params object params.ids
- String search by few id divided by comma (e.g. ?ids=124088,123456)params.login
- String search by e-mail address
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.requestPublicUsersInformation(params);
})();
Returns Promise<userInfo>
User - Set new email to user using change email token
#### Parameters
- params object params.token
- String User change email token.params.scope
- String List of oauth scopes divided by space.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.setNewEmailUsingEmailToken(params);
})();
Returns Promise<userInfo>
User - Set new password to user using change password token
#### Parameters
- params object params.token
- String User change email token.params.scope
- String List of oauth scopes divided by space.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.setNewPasswordToUserUsingChangePasswordToken(params);
})();
Returns Promise<userInfo>
User - Set new password to user using reset token
#### Parameters
- params object params.token
- String User change email token.params.scope
- String List of oauth scopes divided by space.params.password
- String List of oauth scopes divided by space.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.setNewPasswordByResetToken(params);
})();
Returns Promise<userInfo>
User - Set segment option for user identified by access token
#### Parameters
- params object params.segmentOptionId
- Number Segment option ID.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/, token');
const request = await service.setSegmentOptionByToken(params);
})();
Returns Boolean
User - Set segment option for user identified by user id
#### Parameters
- params object params.userId
- Number User ID.params.segmentOptionId
- Number Segment option ID.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/, token');
const request = await service.setSegmentOptionByUserId(params);
})();
Returns Boolean
User - Signin or signup via external auth client
#### Parameters
- params object params.clientName
- String Name of external auth client - facebook, google, etc..params.token
- String OAuth access token from external auth provider.params.scope
- String List of oauth scopes divided by space.params.segmentOptionId
- Number Segment option id.params.subscription
- Boolean Subscribe user to newsletter.params.locale
- String Subscription locale (if not specified default 'en' will be used).
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.signinSignupViaAuthClient(params);
})();
Returns Promise<userInfo>
User - Subscribe user to newsletters
#### Parameters
- params object params.segmentOptionId
- Number Segment option ID.params.locale
- Number Locale.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/, token');
const request = await service.subscribeUserToNewsletters(params);
})();
Returns Boolean
UserToken - Request User Token information
#### Parameters
- params Object params.token
- number User token string.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/', token);
const request = await service.requestUserTokenInformation(params);
})();
Returns Promise<listOfUsers>
User - Get users total count {get} /users api call
#### Parameters
- params object params.id
- Number users AuthClient unique ID.
#### Examples
`javascript`
(async () => {
const service = new Service('//api.templatemonsterdev.com/users/v1/');
const request = await service.getPublicUsersCount();
})();
Returns Promise<usersCountData>
user object
Type: user
- userName string full nameavatar
- string avatar urlbackground` string background color
-