User

---

Get logged in user

Get current logged in user.

const response = await geocore.User.get();

Parameters

name	type	data type	description
None

Create user

Create a new user.

const response = await geocore.User.createUser({
  username: "exampleUser",
  password: "BVT2FMhbaaXGwPoC3SRoJipqBsiqo127FbbMMf5@69d3!9d1V@?T8*6PDSXw",
  email: "user@example.com",
  name: "string",
  accessLevel: "string"
});

Prerequisites

Successfully get the IdToken with superAdmin access level from login API.

Parameters

name	type	data type	description
username	required	string	Username
password	required	string	Password
email	required	string	Email
name	required	string	Full name
accessLevel	required	string	User access level

Update user

Update a user.

const response = await geocore.User.update(userId, {
  serialNumber: "123456789",
  name: "string",
});

Prerequisites

Successfully get the IdToken with superAdmin or user access level from login API.

Parameters

name	type	data type	description
userId	required	string	User ID
name	optional	string	Full name
serialNumber	optional	string	User serial number
isEnableMFA	optional	string	Enable MFA for user

Update user map setting

Update a user map setting.

const response = await geocore.User.updateUserSetting({
  appModule: "HazardView",
  defaultZoom: 6,
  defaultCenterLocation: {
    lng: number;
    lat: number;
  };
  defaultMapStyle: 'roadmap';
  defaultDisplayMode: 'light';
});

Prerequisites

Successfully get the IdToken with superAdmin or user access level from login API.

Parameters

name	type	data type	description
appModule	required	string	App module name, must be HazardView, Maps, Facilites, LiveGo or LocationTracking
defaultZoom	required	string	Default map zoom level
defaultCenterLocation[lng]	required	string	Default map center location longitude
defaultCenterLocation[lat]	required	string	Default map center location latitude
defaultMapStyle	required	string	Default map style, must be roadmap, dark_roadmap, terrain or satellite
defaultDisplayMode	required	string	Default display theme, must be light or dark

Update user password

Update a new user password.

const response = await geocore.User.updatePassword(userId, {
  oldPassword: "string",
  newPassword: "string",
});

Prerequisites

Successfully get the IdToken with superAdmin or user access level from login API.

Parameters

name	type	data type	description
userId	required	string	User ID
oldPassword	required	string	Old password
newPassword	required	string	New password

Import users

Import users from a CSV file.

const formData = new FormData();
formData.append('groupId', groupId);
formData.append('csv', csvFile);

const response = await geocore.User.uploadUsers(formData);

Prerequisites

Successfully get the IdToken with superAdmin access level from login API.

Parameters

name	type	data type	description
groupId	required	string	Group ID to import users into
csv	required	string	CSV file with user information

Export users

Export users to a CSV file.

const response = await geocore.User.exportUsers(groupId);

Prerequisites

Successfully get the IdToken with superAdmin access level from login API.

Parameters

name	type	data type	description
groupId	required	string	Group ID contains users to export

Update user last location

Update last location of logged in user.

const response = await geocore.User.updateLastLocation({
  coordinates: [12, 34]
});

Parameters

name	type	data type	description
coordinates	required	array<number>	Location of user