Skip to content

Scripting API / core/CurrentUserApi / External

External

Classes

CurrentUser

Properties

Property Type Description
email string | undefined User's email, or undefined if the user does not have an email address
id number User's internal ID
language LanguageType 2-Letter ISO code of the user's preferred language
location GSBaseEntity User's currently-selected Location (or their only Location if they are assigned to only one Location)
name string User's display name
navigationAreas NavigationAreaType[] Array of permissions this user has access to
permissions RoleAreaType[] Array of permissions this user has access to
tier AccessTierType GS Access Tier of the customer
username string Username used by the user to log in to GS

Type Aliases

AccessTierType

AccessTierType = "essential" | "premier" | "enterprise"


LanguageType

LanguageType = "en" | "es"


NavigationAreaType = "inspections" | "quickDataEntry" | "libraryScripts" | "importData" | "dashboards" | "reports" | "parts" | "characteristics" | "processes" | "defectCategories" | "defects" | "traceability" | "filters" | "realTimeFailures" | "units" | "serialDevices" | "alerts" | "workstations" | "tags" | "localQueries" | "globalSettings" | "deviceSettings" | "locations" | "systemLabels" | "customTranslations" | "accountInfo" | "users" | "apiKeys" | "groups" | "roles" | "licenses" | "files" | "exportData" | "schedules" | "mySchedules"


RoleAreaType

RoleAreaType = "apiKeyView" | "apiKeyCreate" | "apiKeyUpdate" | "apiKeyDelete" | "groupView" | "groupCreate" | "groupUpdate" | "groupDelete" | "roleView" | "roleCreate" | "roleUpdate" | "roleDelete" | "userView" | "userCreate" | "userUpdate" | "userDelete" | "userResetPassword" | "dashboardView" | "dashboardCreate" | "dashboardUpdate" | "dashboardDelete" | "reportView" | "reportCreate" | "reportUpdate" | "reportDelete" | "fileView" | "fileCreate" | "fileUpdate" | "fileDelete" | "folderView" | "folderCreate" | "folderUpdate" | "folderDelete" | "partView" | "partCreate" | "partUpdate" | "partDelete" | "characteristicView" | "characteristicCreate" | "characteristicUpdate" | "characteristicDelete" | "processView" | "processCreate" | "processUpdate" | "processDelete" | "defectCategoryView" | "defectCategoryCreate" | "defectCategoryUpdate" | "defectCategoryDelete" | "defectView" | "defectCreate" | "defectUpdate" | "defectDelete" | "traceabilityView" | "traceabilityCreate" | "traceabilityUpdate" | "traceabilityDelete" | "filterView" | "filterCreate" | "filterUpdate" | "filterDelete" | "realTimeFailureGroupView" | "realTimeFailureGroupCreate" | "realTimeFailureGroupUpdate" | "realTimeFailureGroupDelete" | "unitView" | "unitCreate" | "unitUpdate" | "unitDelete" | "serialDeviceView" | "serialDeviceCreate" | "serialDeviceUpdate" | "serialDeviceDelete" | "alertView" | "alertCreate" | "alertUpdate" | "alertDelete" | "workstationView" | "workstationCreate" | "workstationUpdate" | "workstationDelete" | "entityTagView" | "entityTagCreate" | "entityTagUpdate" | "entityTagDelete" | "databaseQueryView" | "databaseQueryCreate" | "databaseQueryUpdate" | "databaseQueryDelete" | "globalSettingManage" | "systemLabelsManage" | "customTranslationsManage" | "resetDevelopmentSite" | "accountInformationView" | "systemWideAuditView" | "inspectionListRunAnyRevision" | "inspectionListRunPublishedRevision" | "inspectionCreateUpdate" | "inspectionView" | "inspectionDelete" | "inspectionReceiveScheduleNotifications" | "retrieveAndAnalyzeData" | "developerMode" | "dataRecordViewIndividual" | "dataRecordCreate" | "dataRecordUpdate" | "dataRecordDelete" | "locationCreate" | "locationUpdate" | "locationDelete" | "licenseViewCurrentUsage" | "licenseViewHistory" | "licenseRevoke" | "quickDataEntryRun" | "libraryScriptRunPublishedRevision" | "libraryScriptView" | "libraryScriptCreate" | "libraryScriptUpdate" | "libraryScriptDelete" | "deviceSettingsManage" | "locationAccessAll" | "dashboardShare" | "exportData" | "reportSchedule" | "scheduleView" | "scheduleCreate" | "scheduleUpdate" | "scheduleDelete" | "askAI"