Group
List groups
Get a list of groups.
const response = await geocore.Group.groupList({
name: "name",
parent: "parent",
description: "description",
createdRange: {
start: "2025-01-01",
end: "2025-01-01",
}
updatedRange: {
start: "2025-01-01",
end: "2025-01-01",
}
page: 1,
limit: 10,
});
Prerequisites
Successfully get the IdToken with superAdmin, companyAdmin or groupAdmin access level from login API.
Parameters
name type data type description name optional string Search by group name parent optional string Search by parent group ID description optional string Search by group description createdRange[start] optional date Search by createdAttimestampcreatedRange[end] optional date Search by createdAttimestampupdatedRange[start] optional date Search by modifiedAttimestampupdatedRange[end] optional date Search by modifiedAttimestamppage optional number Page ordinal number limit optional number Number of records per page
Get a group
Get managers
Get a list of group managers.
const response = await geocore.Group.findManagers({
name: "name",
username: "username",
email: "email",
lastLoginRange: {
start: "2025-01-01",
end: "2025-01-01",
}
createdRange: {
start: "2025-01-01",
end: "2025-01-01",
}
updatedRange: {
start: "2025-01-01",
end: "2025-01-01",
}
page: 1,
limit: 10,
});
Prerequisites
Successfully get the IdToken with superAdmin access level from login API.
Parameters
name type data type description username optional string Search by username name optional string Search by full name optional string Search by email lastLoginRange[start] optional date Search by lastLoginTimetimestamplastLoginRange[end] optional date Search by lastLoginTimetimestampcreatedRange[start] optional date Search by createdAttimestampcreatedRange[end] optional date Search by createdAttimestampupdatedRange[start] optional date Search by modifiedAttimestampupdatedRange[end] optional date Search by modifiedAttimestamppage optional number Page ordinal number limit optional number Number of records per page
Create group
Create a new group.
const response = await geocore.Group.createGroup({
name: "string",
description: "string",
userIds: ["string"],
managerIds: ["string"],
parent: "string"
});
Prerequisites
Successfully get the IdToken with superAdmin or companyAdmin access level from login API.
Parameters
name type data type description name required string Group name description required string Group description userIds required array<string> ID of group members managerIds required array<string> ID of group managers parent required string ID of parent group
Update group
Update a group.
const response = await geocore.Group.updateGroup(
groupId,
{
name: "string",
description: "string",
aiIntegration: "OpenAI" | "SageMaker",
}
);
Prerequisites
Successfully get the IdToken with superAdmin or companyAdmin access level from login API.
Parameters
name type data type description groupId required string Group ID name required string Group name description required string Group description aiIntegration required string AI integration option of company groups, not apply to subgroups
Delete group
Add users to a group
Add users to a group
const response = await geocore.Group.addUsers(
groupId,
{
userIds: ["string"],
}
);
Prerequisites
Successfully get the IdToken with superAdmin, companyAdmin or groupAdmin access level from login API.
Parameters
name type data type description groupId required string Group ID userIds required array<string> ID of users
Remove users from a group
Remove users from a group
const response = await geocore.Group.removeUsers(
groupId,
{
userIds: ["string"],
}
);
Prerequisites
Successfully get the IdToken with superAdmin, companyAdmin or groupAdmin access level from login API.
Parameters
name type data type description groupId required string Group ID userIds required array<string> ID of users
Add managers to a group
Add managers to a group
const response = await geocore.Group.addManagers(
groupId,
{
userIds: ["string"],
}
);
Prerequisites
Successfully get the IdToken with superAdmin or companyAdmin access level from login API.
Parameters
name type data type description groupId required string Group ID userIds required array<string> ID of users
Remove managers from a group
Remove managers from a group
const response = await geocore.Group.removeManagers(
groupId,
{
userIds: ["string"],
}
);
Prerequisites
Successfully get the IdToken with superAdmin or companyAdmin access level from login API.
Parameters
name type data type description groupId required string Group ID userIds required array<string> ID of users
Update group platform configuration
Update group platform configuration.
const response = await geocore.Group.updatePlatformConfig(
groupId,
{
platformId: "string",
enabled: true,
bandwidthLimit: 0,
storagePlan: 0
}
);
Prerequisites
Successfully get the IdToken with superAdmin access level from login API.
Parameters
name type data type description groupId required string Group ID platformId required string Platform ID enabled required boolean Enable platform usage bandwidthLimit required number Bandwidth limit storagePlan required number Storage plan
Add whitelist IP access
Add a new whitelist IP to a company group
const response = await geocore.Request.addWhitelistIpAddress(
groupId,
{
ipAddress: "1.2.3.4",
description: "string",
}
);
Prerequisites
Successfully get the IdToken with superAdmin access level from login API.
Parameters
name type data type description groupId required string Group ID ipAddress required string Whitelist IP address (v4) description required string IP address description
Remove whitelist IP access
Remove whitelist IP access from a company group
const response = await geocore.Group.removeWhitelistIpAddress(
groupId,
{
ipAddresses: ["1.2.3.4"],
}
);
Prerequisites
Successfully get the IdToken with or superAdmin access level from login API.
Parameters
name type data type description groupId required string Group ID ipAddresses required array<string> IP addresses to be removed