connectwise-rest
    Preparing search index...

    Class SystemAPI

    System module

    Hierarchy

    • AutomateBaseAPI
      • SystemAPI
    Index

    Methods

    addUser changePassword deleteUser deleteUserFolder get getClientPermissionList getClientSystemCredentialsList getDatabaseServerDateTimeWithUtcOffset getFeatureFlagList getLicensedProducts getLinkList getPatchInformation getPluginList getRebootPolicyListAsync getServerInformationListAsync getUser getUserAuditList getUserClass getUserClassList getUserClassWebExtensionList getUserFavoriteList getUserFolder getUserFolderList getUserList getUserPermissionList getUserPermissionsAsync getUserSettingList patchUser patchUserFolder post postAuthorizationInitialLink postFeatureFlag postUserAudit postUserFavorite postUserFolder postUserSetting putUserClassWebExtensionList refreshBearerTokenAsync request

    Methods

    • Parameters

      • User: {
            AllowLegacyApiAccess?: boolean;
            AssociatedGroups?: {
                AutoJoinSettings?: {
                    ComputerSearchSettings?: {
                        AutoJoinSearchId?: number;
                        IsLimitedToSearch?: boolean;
                        Name?: string;
                    };
                    ContactSearchSettings?: {
                        AutoJoinSearchId?: number;
                        IsLimitedToSearch?: boolean;
                        Name?: string;
                        ShouldIncludeAssociatedComputers?: boolean;
                    };
                    NetworkDeviceSearchSettings?: {
                        AutoJoinSearchId?: number;
                        IsLimitedToSearch?: boolean;
                        Name?: string;
                    };
                };
                Description?: string;
                FullName?: string;
                GroupId?: number;
                GroupType?: { GroupTypeId?: number; Name?: string };
                LinkingSettings?: {
                    GroupLinkTypeId?: number;
                    GroupLinkTypeName?: string;
                    IsSynchronized?: boolean;
                    LinkedEntityId?: number;
                    LinkedEntityName?: string;
                };
                MaintenanceWindowSettings?: {
                    MaintenanceWindowId?: number;
                    Name?: string;
                };
                MasterStatus?: { MasterStatusTypeId?: number; Name?: string };
                Name?: string;
                TemplateSettings?: {
                    Priority?: number;
                    RemoteAgentTemplate?: { Name?: string; RemoteAgentTemplateId?: number };
                };
            }[];
            AuditingLevel?: number;
            CommandLevel?: number;
            EmailAddress?: string;
            FirstName?: string;
            Folder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: number };
            IsIntegrator?: boolean;
            IsLocked?: boolean;
            IsTicketRouter?: boolean;
            IsTicketSupervisor?: boolean;
            LastName?: string;
            LastSuccessfulLogin?: string;
            LastUpdated?: string;
            Name?: string;
            NewTicketDisplayLimit?: number;
            OpenTicketLimit?: number;
            Password?: string;
            PrimaryClients?: { ClientId?: number; Name?: string }[];
            RequiresLoginReport?: boolean;
            RequiresLogoutReport?: boolean;
            SsoEmail?: string;
            SsoStatus?: { SsoStatusId?: number; StatusName?: string };
            TicketLevel?: { Name?: string; TicketLevelId?: number };
            UserClasses?: {
                BinaryExtensionPermissions?: {
                    ExtensionGuid?: string;
                    ExtensionName?: string;
                    ExtensionPermissionId?: number;
                    PermissionId?: number;
                    PermissionName?: string;
                }[];
                Name?: string;
                Permissions?: {
                    AlertsDeleteAll?: boolean;
                    AlertsUpdate?: boolean;
                    ClassConfig?: boolean;
                    ClientDelete?: boolean;
                    ClientEdit?: boolean;
                    ClientRead?: boolean;
                    ClientsShowAll?: boolean;
                    ComputersCreate?: boolean;
                    ComputersDelete?: boolean;
                    ComputersForceUpdate?: boolean;
                    ComputersShowAll?: boolean;
                    ComputersUpdate?: boolean;
                    ConfigApplicationList?: boolean;
                    ConfigEventBlackList?: boolean;
                    ContactDelete?: boolean;
                    ContactEdit?: boolean;
                    ContactRead?: boolean;
                    CreateTickets?: boolean;
                    DashboardConfig?: boolean;
                    DashManage?: boolean;
                    DashOverview?: boolean;
                    DashTicketing?: boolean;
                    DashTime?: boolean;
                    DashTrending?: boolean;
                    DatabaseExecute?: boolean;
                    DataViewDelete?: boolean;
                    DataViewShowAll?: boolean;
                    DataViewUpdate?: boolean;
                    GroupInfoUpdate?: boolean;
                    GroupManagedServices?: boolean;
                    GroupMonitorsUpdate?: boolean;
                    GroupsCreate?: boolean;
                    GroupsDelete?: boolean;
                    GroupsScheduleScript?: boolean;
                    GroupsShowAll?: boolean;
                    HUDShowAll?: boolean;
                    HUDUpdate?: boolean;
                    InternalMonitorsCreate?: boolean;
                    InternalMonitorsDelete?: boolean;
                    InternalMonitorsUpdate?: boolean;
                    LanguagePackEditor?: boolean;
                    LinksDelete?: boolean;
                    LocationsShowAll?: boolean;
                    ManageAudits?: boolean;
                    ManagedServiceCatalog?: boolean;
                    ManageGroups?: boolean;
                    ManageOfflineComputers?: boolean;
                    ManageOutdated?: boolean;
                    ManageRemoteCommands?: boolean;
                    ManageScheduleClientScripts?: boolean;
                    ManageServiceLogs?: boolean;
                    NavigationMenuUpdate?: boolean;
                    NetworkDeviceDelete?: boolean;
                    NetworkDeviceShowAll?: boolean;
                    NetworkDeviceUpdate?: boolean;
                    PatchManagerConfig?: boolean;
                    PatchManagerRead?: boolean;
                    PatchManagerUpdate?: boolean;
                    PermissionsUpdate?: boolean;
                    PluginManager?: boolean;
                    ProbeTemplateExecute?: boolean;
                    QuickConnect?: boolean;
                    RemoteMonitorsCreate?: boolean;
                    RemoteMonitorsDelete?: boolean;
                    ReportDelete?: boolean;
                    ReportEdit?: boolean;
                    ReportRead?: boolean;
                    ReportsCreate?: boolean;
                    RetiredAssetsDelete?: boolean;
                    RSSFeedRead?: boolean;
                    RSSFeedUpdate?: boolean;
                    ScheduledScriptsUpdate?: boolean;
                    ScriptDelete?: boolean;
                    ScriptEdit?: boolean;
                    ScriptRead?: boolean;
                    SearchesDelete?: boolean;
                    SearchesRead?: boolean;
                    SearchesUpdate?: boolean;
                    ServerStatus?: boolean;
                    SharedLinks?: boolean;
                    ShowPasswords?: boolean;
                    SolutionCenter?: boolean;
                    SQLScriptFunctions?: boolean;
                    SuperAdmin?: boolean;
                    SystemConfig?: boolean;
                    TemplateDelete?: boolean;
                    TemplateEdit?: boolean;
                    TemplateRead?: boolean;
                    TicketsDelete?: boolean;
                    TicketsRead?: boolean;
                    TicketsRequest?: boolean;
                    TicketsUpdate?: boolean;
                    ToolDelete?: boolean;
                    ToolEdit?: boolean;
                    ToolRead?: boolean;
                    UserClassCreate?: boolean;
                    UserClassDelete?: boolean;
                    UserClassRead?: boolean;
                    UserClassUpdate?: boolean;
                    UserDelete?: boolean;
                    UserEdit?: boolean;
                    UserRead?: boolean;
                    UsersShowAll?: boolean;
                };
                UserClassId?: number;
                WebExtensionClaims?: {
                    Description?: string;
                    PermissionKey?: string;
                    PermissionName?: string;
                    WebExtensionId?: number;
                    WebExtensionPermissionId?: number;
                }[];
            }[];
            UserId?: number;
            UsesTicketBasedSecurity?: boolean;
        }
        • OptionalAllowLegacyApiAccess?: boolean
        • OptionalAssociatedGroups?: {
              AutoJoinSettings?: {
                  ComputerSearchSettings?: {
                      AutoJoinSearchId?: number;
                      IsLimitedToSearch?: boolean;
                      Name?: string;
                  };
                  ContactSearchSettings?: {
                      AutoJoinSearchId?: number;
                      IsLimitedToSearch?: boolean;
                      Name?: string;
                      ShouldIncludeAssociatedComputers?: boolean;
                  };
                  NetworkDeviceSearchSettings?: {
                      AutoJoinSearchId?: number;
                      IsLimitedToSearch?: boolean;
                      Name?: string;
                  };
              };
              Description?: string;
              FullName?: string;
              GroupId?: number;
              GroupType?: { GroupTypeId?: number; Name?: string };
              LinkingSettings?: {
                  GroupLinkTypeId?: number;
                  GroupLinkTypeName?: string;
                  IsSynchronized?: boolean;
                  LinkedEntityId?: number;
                  LinkedEntityName?: string;
              };
              MaintenanceWindowSettings?: { MaintenanceWindowId?: number; Name?: string };
              MasterStatus?: { MasterStatusTypeId?: number; Name?: string };
              Name?: string;
              TemplateSettings?: {
                  Priority?: number;
                  RemoteAgentTemplate?: { Name?: string; RemoteAgentTemplateId?: number };
              };
          }[]
        • OptionalAuditingLevel?: number

          Format: int32

        • OptionalCommandLevel?: number

          Format: int32

        • OptionalEmailAddress?: string
        • OptionalFirstName?: string
        • OptionalFolder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: number }
          • OptionalIsSsoEnabled?: boolean
          • OptionalName?: string
          • OptionalUserFolderId?: number

            Format: int32

        • OptionalIsIntegrator?: boolean
        • OptionalIsLocked?: boolean
        • OptionalIsTicketRouter?: boolean
        • OptionalIsTicketSupervisor?: boolean
        • OptionalLastName?: string
        • OptionalLastSuccessfulLogin?: string

          Format: date-time

        • OptionalLastUpdated?: string

          Format: date-time

        • OptionalName?: string
        • OptionalNewTicketDisplayLimit?: number

          Format: int32

        • OptionalOpenTicketLimit?: number

          Format: int32

        • OptionalPassword?: string
        • OptionalPrimaryClients?: { ClientId?: number; Name?: string }[]
        • OptionalRequiresLoginReport?: boolean
        • OptionalRequiresLogoutReport?: boolean
        • OptionalSsoEmail?: string
        • OptionalSsoStatus?: { SsoStatusId?: number; StatusName?: string }
          • OptionalSsoStatusId?: number

            Format: int32

          • OptionalStatusName?: string
        • OptionalTicketLevel?: { Name?: string; TicketLevelId?: number }
          • OptionalName?: string
          • OptionalTicketLevelId?: number

            Format: int32

        • OptionalUserClasses?: {
              BinaryExtensionPermissions?: {
                  ExtensionGuid?: string;
                  ExtensionName?: string;
                  ExtensionPermissionId?: number;
                  PermissionId?: number;
                  PermissionName?: string;
              }[];
              Name?: string;
              Permissions?: {
                  AlertsDeleteAll?: boolean;
                  AlertsUpdate?: boolean;
                  ClassConfig?: boolean;
                  ClientDelete?: boolean;
                  ClientEdit?: boolean;
                  ClientRead?: boolean;
                  ClientsShowAll?: boolean;
                  ComputersCreate?: boolean;
                  ComputersDelete?: boolean;
                  ComputersForceUpdate?: boolean;
                  ComputersShowAll?: boolean;
                  ComputersUpdate?: boolean;
                  ConfigApplicationList?: boolean;
                  ConfigEventBlackList?: boolean;
                  ContactDelete?: boolean;
                  ContactEdit?: boolean;
                  ContactRead?: boolean;
                  CreateTickets?: boolean;
                  DashboardConfig?: boolean;
                  DashManage?: boolean;
                  DashOverview?: boolean;
                  DashTicketing?: boolean;
                  DashTime?: boolean;
                  DashTrending?: boolean;
                  DatabaseExecute?: boolean;
                  DataViewDelete?: boolean;
                  DataViewShowAll?: boolean;
                  DataViewUpdate?: boolean;
                  GroupInfoUpdate?: boolean;
                  GroupManagedServices?: boolean;
                  GroupMonitorsUpdate?: boolean;
                  GroupsCreate?: boolean;
                  GroupsDelete?: boolean;
                  GroupsScheduleScript?: boolean;
                  GroupsShowAll?: boolean;
                  HUDShowAll?: boolean;
                  HUDUpdate?: boolean;
                  InternalMonitorsCreate?: boolean;
                  InternalMonitorsDelete?: boolean;
                  InternalMonitorsUpdate?: boolean;
                  LanguagePackEditor?: boolean;
                  LinksDelete?: boolean;
                  LocationsShowAll?: boolean;
                  ManageAudits?: boolean;
                  ManagedServiceCatalog?: boolean;
                  ManageGroups?: boolean;
                  ManageOfflineComputers?: boolean;
                  ManageOutdated?: boolean;
                  ManageRemoteCommands?: boolean;
                  ManageScheduleClientScripts?: boolean;
                  ManageServiceLogs?: boolean;
                  NavigationMenuUpdate?: boolean;
                  NetworkDeviceDelete?: boolean;
                  NetworkDeviceShowAll?: boolean;
                  NetworkDeviceUpdate?: boolean;
                  PatchManagerConfig?: boolean;
                  PatchManagerRead?: boolean;
                  PatchManagerUpdate?: boolean;
                  PermissionsUpdate?: boolean;
                  PluginManager?: boolean;
                  ProbeTemplateExecute?: boolean;
                  QuickConnect?: boolean;
                  RemoteMonitorsCreate?: boolean;
                  RemoteMonitorsDelete?: boolean;
                  ReportDelete?: boolean;
                  ReportEdit?: boolean;
                  ReportRead?: boolean;
                  ReportsCreate?: boolean;
                  RetiredAssetsDelete?: boolean;
                  RSSFeedRead?: boolean;
                  RSSFeedUpdate?: boolean;
                  ScheduledScriptsUpdate?: boolean;
                  ScriptDelete?: boolean;
                  ScriptEdit?: boolean;
                  ScriptRead?: boolean;
                  SearchesDelete?: boolean;
                  SearchesRead?: boolean;
                  SearchesUpdate?: boolean;
                  ServerStatus?: boolean;
                  SharedLinks?: boolean;
                  ShowPasswords?: boolean;
                  SolutionCenter?: boolean;
                  SQLScriptFunctions?: boolean;
                  SuperAdmin?: boolean;
                  SystemConfig?: boolean;
                  TemplateDelete?: boolean;
                  TemplateEdit?: boolean;
                  TemplateRead?: boolean;
                  TicketsDelete?: boolean;
                  TicketsRead?: boolean;
                  TicketsRequest?: boolean;
                  TicketsUpdate?: boolean;
                  ToolDelete?: boolean;
                  ToolEdit?: boolean;
                  ToolRead?: boolean;
                  UserClassCreate?: boolean;
                  UserClassDelete?: boolean;
                  UserClassRead?: boolean;
                  UserClassUpdate?: boolean;
                  UserDelete?: boolean;
                  UserEdit?: boolean;
                  UserRead?: boolean;
                  UsersShowAll?: boolean;
              };
              UserClassId?: number;
              WebExtensionClaims?: {
                  Description?: string;
                  PermissionKey?: string;
                  PermissionName?: string;
                  WebExtensionId?: number;
                  WebExtensionPermissionId?: number;
              }[];
          }[]
        • OptionalUserId?: number

          Format: int32

        • OptionalUsesTicketBasedSecurity?: boolean

      Returns Promise<
          {
              AllowLegacyApiAccess?: boolean;
              AssociatedGroups?: {
                  AutoJoinSettings?: {
                      ComputerSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                      };
                      ContactSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                          ShouldIncludeAssociatedComputers?: boolean;
                      };
                      NetworkDeviceSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                      };
                  };
                  Description?: string;
                  FullName?: string;
                  GroupId?: number;
                  GroupType?: { GroupTypeId?: number; Name?: string };
                  LinkingSettings?: {
                      GroupLinkTypeId?: number;
                      GroupLinkTypeName?: string;
                      IsSynchronized?: boolean;
                      LinkedEntityId?: number;
                      LinkedEntityName?: string;
                  };
                  MaintenanceWindowSettings?: {
                      MaintenanceWindowId?: number;
                      Name?: string;
                  };
                  MasterStatus?: { MasterStatusTypeId?: number; Name?: string };
                  Name?: string;
                  TemplateSettings?: {
                      Priority?: number;
                      RemoteAgentTemplate?: { Name?: string; RemoteAgentTemplateId?: number };
                  };
              }[];
              AuditingLevel?: number;
              CommandLevel?: number;
              EmailAddress?: string;
              FirstName?: string;
              Folder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: number };
              IsIntegrator?: boolean;
              IsLocked?: boolean;
              IsTicketRouter?: boolean;
              IsTicketSupervisor?: boolean;
              LastName?: string;
              LastSuccessfulLogin?: string;
              LastUpdated?: string;
              Name?: string;
              NewTicketDisplayLimit?: number;
              OpenTicketLimit?: number;
              Password?: string;
              PrimaryClients?: { ClientId?: number; Name?: string }[];
              RequiresLoginReport?: boolean;
              RequiresLogoutReport?: boolean;
              SsoEmail?: string;
              SsoStatus?: { SsoStatusId?: number; StatusName?: string };
              TicketLevel?: { Name?: string; TicketLevelId?: number };
              UserClasses?: {
                  BinaryExtensionPermissions?: {
                      ExtensionGuid?: string;
                      ExtensionName?: string;
                      ExtensionPermissionId?: number;
                      PermissionId?: number;
                      PermissionName?: string;
                  }[];
                  Name?: string;
                  Permissions?: {
                      AlertsDeleteAll?: boolean;
                      AlertsUpdate?: boolean;
                      ClassConfig?: boolean;
                      ClientDelete?: boolean;
                      ClientEdit?: boolean;
                      ClientRead?: boolean;
                      ClientsShowAll?: boolean;
                      ComputersCreate?: boolean;
                      ComputersDelete?: boolean;
                      ComputersForceUpdate?: boolean;
                      ComputersShowAll?: boolean;
                      ComputersUpdate?: boolean;
                      ConfigApplicationList?: boolean;
                      ConfigEventBlackList?: boolean;
                      ContactDelete?: boolean;
                      ContactEdit?: boolean;
                      ContactRead?: boolean;
                      CreateTickets?: boolean;
                      DashboardConfig?: boolean;
                      DashManage?: boolean;
                      DashOverview?: boolean;
                      DashTicketing?: boolean;
                      DashTime?: boolean;
                      DashTrending?: boolean;
                      DatabaseExecute?: boolean;
                      DataViewDelete?: boolean;
                      DataViewShowAll?: boolean;
                      DataViewUpdate?: boolean;
                      GroupInfoUpdate?: boolean;
                      GroupManagedServices?: boolean;
                      GroupMonitorsUpdate?: boolean;
                      GroupsCreate?: boolean;
                      GroupsDelete?: boolean;
                      GroupsScheduleScript?: boolean;
                      GroupsShowAll?: boolean;
                      HUDShowAll?: boolean;
                      HUDUpdate?: boolean;
                      InternalMonitorsCreate?: boolean;
                      InternalMonitorsDelete?: boolean;
                      InternalMonitorsUpdate?: boolean;
                      LanguagePackEditor?: boolean;
                      LinksDelete?: boolean;
                      LocationsShowAll?: boolean;
                      ManageAudits?: boolean;
                      ManagedServiceCatalog?: boolean;
                      ManageGroups?: boolean;
                      ManageOfflineComputers?: boolean;
                      ManageOutdated?: boolean;
                      ManageRemoteCommands?: boolean;
                      ManageScheduleClientScripts?: boolean;
                      ManageServiceLogs?: boolean;
                      NavigationMenuUpdate?: boolean;
                      NetworkDeviceDelete?: boolean;
                      NetworkDeviceShowAll?: boolean;
                      NetworkDeviceUpdate?: boolean;
                      PatchManagerConfig?: boolean;
                      PatchManagerRead?: boolean;
                      PatchManagerUpdate?: boolean;
                      PermissionsUpdate?: boolean;
                      PluginManager?: boolean;
                      ProbeTemplateExecute?: boolean;
                      QuickConnect?: boolean;
                      RemoteMonitorsCreate?: boolean;
                      RemoteMonitorsDelete?: boolean;
                      ReportDelete?: boolean;
                      ReportEdit?: boolean;
                      ReportRead?: boolean;
                      ReportsCreate?: boolean;
                      RetiredAssetsDelete?: boolean;
                      RSSFeedRead?: boolean;
                      RSSFeedUpdate?: boolean;
                      ScheduledScriptsUpdate?: boolean;
                      ScriptDelete?: boolean;
                      ScriptEdit?: boolean;
                      ScriptRead?: boolean;
                      SearchesDelete?: boolean;
                      SearchesRead?: boolean;
                      SearchesUpdate?: boolean;
                      ServerStatus?: boolean;
                      SharedLinks?: boolean;
                      ShowPasswords?: boolean;
                      SolutionCenter?: boolean;
                      SQLScriptFunctions?: boolean;
                      SuperAdmin?: boolean;
                      SystemConfig?: boolean;
                      TemplateDelete?: boolean;
                      TemplateEdit?: boolean;
                      TemplateRead?: boolean;
                      TicketsDelete?: boolean;
                      TicketsRead?: boolean;
                      TicketsRequest?: boolean;
                      TicketsUpdate?: boolean;
                      ToolDelete?: boolean;
                      ToolEdit?: boolean;
                      ToolRead?: boolean;
                      UserClassCreate?: boolean;
                      UserClassDelete?: boolean;
                      UserClassRead?: boolean;
                      UserClassUpdate?: boolean;
                      UserDelete?: boolean;
                      UserEdit?: boolean;
                      UserRead?: boolean;
                      UsersShowAll?: boolean;
                  };
                  UserClassId?: number;
                  WebExtensionClaims?: {
                      Description?: string;
                      PermissionKey?: string;
                      PermissionName?: string;
                      WebExtensionId?: number;
                      WebExtensionPermissionId?: number;
                  }[];
              }[];
              UserId?: number;
              UsesTicketBasedSecurity?: boolean;
          },
      >

    • Parameters

      • userId: number
      • ChangePasswordRequest: { NewPassword?: string; OldPassword?: string }

      Returns Promise<undefined>

    • Parameters

      • userFolderId: number

      Returns Promise<undefined>

    • Returns Promise<
          {
              AllowDirect?: boolean;
              AllowServiceRegistration?: boolean;
              AutomateRedirectUri?: string;
              Services?: {
                  AuthenticationType?: number;
                  ClientId?: string;
                  IsAutomatic?: boolean;
                  IsDefault?: boolean;
                  IsEnabled?: boolean;
                  IsLocalLoginEnabled?: boolean;
                  ServiceGuid?: string;
                  ServiceId?: number;
                  ServiceName?: string;
                  ServiceType?: number;
                  ServiceURI?: string;
              }[];
          },
      >

    • Parameters

      • clientId: number

      Returns Promise<string[]>

    • Parameters

      Returns Promise<
          {
              ClientId?: number;
              CredentialsId?: number;
              ExpirationDate?: string;
              IsActive?: boolean;
              Title?: string;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              CdKey?: string;
              CurrentLicenseUsage?: number;
              Data?: string;
              IsLicenseActive?: boolean;
              LicenseFile?: string;
              MaxLicenseUsage?: number;
              ProductId?: number;
              ProductSku?: string;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              ControlCenterPatchVersion?: string;
              DBAgentServerPatchVersion?: string;
              LastPatchedDate?: string;
              LinuxAgentPatchVersion?: string;
              MacAgentPatchVersion?: string;
              RemoteAgentPatchVersion?: string;
              WebServerPatchVersion?: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              CPUCores?: number;
              CPUName?: string;
              CPUSockets?: number;
              IsDatabaseServer?: boolean;
              IsWebServer?: boolean;
              LogicalProcessors?: number;
              MacAddress?: string;
              MachineName?: string;
              MemoryTotal?: number;
              OperatingSystem?: string;
              ServerId?: number;
          }[],
      >

    • Parameters

      Returns Promise<
          {
              AllowLegacyApiAccess?: boolean;
              AssociatedGroups?: {
                  AutoJoinSettings?: {
                      ComputerSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                      };
                      ContactSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                          ShouldIncludeAssociatedComputers?: boolean;
                      };
                      NetworkDeviceSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                      };
                  };
                  Description?: string;
                  FullName?: string;
                  GroupId?: number;
                  GroupType?: { GroupTypeId?: number; Name?: string };
                  LinkingSettings?: {
                      GroupLinkTypeId?: number;
                      GroupLinkTypeName?: string;
                      IsSynchronized?: boolean;
                      LinkedEntityId?: number;
                      LinkedEntityName?: string;
                  };
                  MaintenanceWindowSettings?: {
                      MaintenanceWindowId?: number;
                      Name?: string;
                  };
                  MasterStatus?: { MasterStatusTypeId?: number; Name?: string };
                  Name?: string;
                  TemplateSettings?: {
                      Priority?: number;
                      RemoteAgentTemplate?: { Name?: string; RemoteAgentTemplateId?: number };
                  };
              }[];
              AuditingLevel?: number;
              CommandLevel?: number;
              EmailAddress?: string;
              FirstName?: string;
              Folder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: number };
              IsIntegrator?: boolean;
              IsLocked?: boolean;
              IsTicketRouter?: boolean;
              IsTicketSupervisor?: boolean;
              LastName?: string;
              LastSuccessfulLogin?: string;
              LastUpdated?: string;
              Name?: string;
              NewTicketDisplayLimit?: number;
              OpenTicketLimit?: number;
              Password?: string;
              PrimaryClients?: { ClientId?: number; Name?: string }[];
              RequiresLoginReport?: boolean;
              RequiresLogoutReport?: boolean;
              SsoEmail?: string;
              SsoStatus?: { SsoStatusId?: number; StatusName?: string };
              TicketLevel?: { Name?: string; TicketLevelId?: number };
              UserClasses?: {
                  BinaryExtensionPermissions?: {
                      ExtensionGuid?: string;
                      ExtensionName?: string;
                      ExtensionPermissionId?: number;
                      PermissionId?: number;
                      PermissionName?: string;
                  }[];
                  Name?: string;
                  Permissions?: {
                      AlertsDeleteAll?: boolean;
                      AlertsUpdate?: boolean;
                      ClassConfig?: boolean;
                      ClientDelete?: boolean;
                      ClientEdit?: boolean;
                      ClientRead?: boolean;
                      ClientsShowAll?: boolean;
                      ComputersCreate?: boolean;
                      ComputersDelete?: boolean;
                      ComputersForceUpdate?: boolean;
                      ComputersShowAll?: boolean;
                      ComputersUpdate?: boolean;
                      ConfigApplicationList?: boolean;
                      ConfigEventBlackList?: boolean;
                      ContactDelete?: boolean;
                      ContactEdit?: boolean;
                      ContactRead?: boolean;
                      CreateTickets?: boolean;
                      DashboardConfig?: boolean;
                      DashManage?: boolean;
                      DashOverview?: boolean;
                      DashTicketing?: boolean;
                      DashTime?: boolean;
                      DashTrending?: boolean;
                      DatabaseExecute?: boolean;
                      DataViewDelete?: boolean;
                      DataViewShowAll?: boolean;
                      DataViewUpdate?: boolean;
                      GroupInfoUpdate?: boolean;
                      GroupManagedServices?: boolean;
                      GroupMonitorsUpdate?: boolean;
                      GroupsCreate?: boolean;
                      GroupsDelete?: boolean;
                      GroupsScheduleScript?: boolean;
                      GroupsShowAll?: boolean;
                      HUDShowAll?: boolean;
                      HUDUpdate?: boolean;
                      InternalMonitorsCreate?: boolean;
                      InternalMonitorsDelete?: boolean;
                      InternalMonitorsUpdate?: boolean;
                      LanguagePackEditor?: boolean;
                      LinksDelete?: boolean;
                      LocationsShowAll?: boolean;
                      ManageAudits?: boolean;
                      ManagedServiceCatalog?: boolean;
                      ManageGroups?: boolean;
                      ManageOfflineComputers?: boolean;
                      ManageOutdated?: boolean;
                      ManageRemoteCommands?: boolean;
                      ManageScheduleClientScripts?: boolean;
                      ManageServiceLogs?: boolean;
                      NavigationMenuUpdate?: boolean;
                      NetworkDeviceDelete?: boolean;
                      NetworkDeviceShowAll?: boolean;
                      NetworkDeviceUpdate?: boolean;
                      PatchManagerConfig?: boolean;
                      PatchManagerRead?: boolean;
                      PatchManagerUpdate?: boolean;
                      PermissionsUpdate?: boolean;
                      PluginManager?: boolean;
                      ProbeTemplateExecute?: boolean;
                      QuickConnect?: boolean;
                      RemoteMonitorsCreate?: boolean;
                      RemoteMonitorsDelete?: boolean;
                      ReportDelete?: boolean;
                      ReportEdit?: boolean;
                      ReportRead?: boolean;
                      ReportsCreate?: boolean;
                      RetiredAssetsDelete?: boolean;
                      RSSFeedRead?: boolean;
                      RSSFeedUpdate?: boolean;
                      ScheduledScriptsUpdate?: boolean;
                      ScriptDelete?: boolean;
                      ScriptEdit?: boolean;
                      ScriptRead?: boolean;
                      SearchesDelete?: boolean;
                      SearchesRead?: boolean;
                      SearchesUpdate?: boolean;
                      ServerStatus?: boolean;
                      SharedLinks?: boolean;
                      ShowPasswords?: boolean;
                      SolutionCenter?: boolean;
                      SQLScriptFunctions?: boolean;
                      SuperAdmin?: boolean;
                      SystemConfig?: boolean;
                      TemplateDelete?: boolean;
                      TemplateEdit?: boolean;
                      TemplateRead?: boolean;
                      TicketsDelete?: boolean;
                      TicketsRead?: boolean;
                      TicketsRequest?: boolean;
                      TicketsUpdate?: boolean;
                      ToolDelete?: boolean;
                      ToolEdit?: boolean;
                      ToolRead?: boolean;
                      UserClassCreate?: boolean;
                      UserClassDelete?: boolean;
                      UserClassRead?: boolean;
                      UserClassUpdate?: boolean;
                      UserDelete?: boolean;
                      UserEdit?: boolean;
                      UserRead?: boolean;
                      UsersShowAll?: boolean;
                  };
                  UserClassId?: number;
                  WebExtensionClaims?: {
                      Description?: string;
                      PermissionKey?: string;
                      PermissionName?: string;
                      WebExtensionId?: number;
                      WebExtensionPermissionId?: number;
                  }[];
              }[];
              UserId?: number;
              UsesTicketBasedSecurity?: boolean;
          },
      >

    • Parameters

      Returns Promise<
          {
              AuditAction?: {
                  ExtensionName?: string;
                  Id?: number;
                  Level?: number;
                  Name?: string;
              };
              DateCreated?: string;
              ExternalId?: number;
              Id?: number;
              Message?: string;
              SecondaryIdentifier?: string;
              Source?: { Id?: number; Name?: string };
              User?: {
                  EmailAddress?: string;
                  Folder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: string };
                  Name?: string;
                  SsoStatus?: { SsoStatusId?: number; StatusName?: string };
                  UserId?: string;
              };
          }[],
      >

    • Parameters

      Returns Promise<
          {
              BinaryExtensionPermissions?: {
                  ExtensionGuid?: string;
                  ExtensionName?: string;
                  ExtensionPermissionId?: number;
                  PermissionId?: number;
                  PermissionName?: string;
              }[];
              Name?: string;
              Permissions?: {
                  AlertsDeleteAll?: boolean;
                  AlertsUpdate?: boolean;
                  ClassConfig?: boolean;
                  ClientDelete?: boolean;
                  ClientEdit?: boolean;
                  ClientRead?: boolean;
                  ClientsShowAll?: boolean;
                  ComputersCreate?: boolean;
                  ComputersDelete?: boolean;
                  ComputersForceUpdate?: boolean;
                  ComputersShowAll?: boolean;
                  ComputersUpdate?: boolean;
                  ConfigApplicationList?: boolean;
                  ConfigEventBlackList?: boolean;
                  ContactDelete?: boolean;
                  ContactEdit?: boolean;
                  ContactRead?: boolean;
                  CreateTickets?: boolean;
                  DashboardConfig?: boolean;
                  DashManage?: boolean;
                  DashOverview?: boolean;
                  DashTicketing?: boolean;
                  DashTime?: boolean;
                  DashTrending?: boolean;
                  DatabaseExecute?: boolean;
                  DataViewDelete?: boolean;
                  DataViewShowAll?: boolean;
                  DataViewUpdate?: boolean;
                  GroupInfoUpdate?: boolean;
                  GroupManagedServices?: boolean;
                  GroupMonitorsUpdate?: boolean;
                  GroupsCreate?: boolean;
                  GroupsDelete?: boolean;
                  GroupsScheduleScript?: boolean;
                  GroupsShowAll?: boolean;
                  HUDShowAll?: boolean;
                  HUDUpdate?: boolean;
                  InternalMonitorsCreate?: boolean;
                  InternalMonitorsDelete?: boolean;
                  InternalMonitorsUpdate?: boolean;
                  LanguagePackEditor?: boolean;
                  LinksDelete?: boolean;
                  LocationsShowAll?: boolean;
                  ManageAudits?: boolean;
                  ManagedServiceCatalog?: boolean;
                  ManageGroups?: boolean;
                  ManageOfflineComputers?: boolean;
                  ManageOutdated?: boolean;
                  ManageRemoteCommands?: boolean;
                  ManageScheduleClientScripts?: boolean;
                  ManageServiceLogs?: boolean;
                  NavigationMenuUpdate?: boolean;
                  NetworkDeviceDelete?: boolean;
                  NetworkDeviceShowAll?: boolean;
                  NetworkDeviceUpdate?: boolean;
                  PatchManagerConfig?: boolean;
                  PatchManagerRead?: boolean;
                  PatchManagerUpdate?: boolean;
                  PermissionsUpdate?: boolean;
                  PluginManager?: boolean;
                  ProbeTemplateExecute?: boolean;
                  QuickConnect?: boolean;
                  RemoteMonitorsCreate?: boolean;
                  RemoteMonitorsDelete?: boolean;
                  ReportDelete?: boolean;
                  ReportEdit?: boolean;
                  ReportRead?: boolean;
                  ReportsCreate?: boolean;
                  RetiredAssetsDelete?: boolean;
                  RSSFeedRead?: boolean;
                  RSSFeedUpdate?: boolean;
                  ScheduledScriptsUpdate?: boolean;
                  ScriptDelete?: boolean;
                  ScriptEdit?: boolean;
                  ScriptRead?: boolean;
                  SearchesDelete?: boolean;
                  SearchesRead?: boolean;
                  SearchesUpdate?: boolean;
                  ServerStatus?: boolean;
                  SharedLinks?: boolean;
                  ShowPasswords?: boolean;
                  SolutionCenter?: boolean;
                  SQLScriptFunctions?: boolean;
                  SuperAdmin?: boolean;
                  SystemConfig?: boolean;
                  TemplateDelete?: boolean;
                  TemplateEdit?: boolean;
                  TemplateRead?: boolean;
                  TicketsDelete?: boolean;
                  TicketsRead?: boolean;
                  TicketsRequest?: boolean;
                  TicketsUpdate?: boolean;
                  ToolDelete?: boolean;
                  ToolEdit?: boolean;
                  ToolRead?: boolean;
                  UserClassCreate?: boolean;
                  UserClassDelete?: boolean;
                  UserClassRead?: boolean;
                  UserClassUpdate?: boolean;
                  UserDelete?: boolean;
                  UserEdit?: boolean;
                  UserRead?: boolean;
                  UsersShowAll?: boolean;
              };
              UserClassId?: number;
              WebExtensionClaims?: {
                  Description?: string;
                  PermissionKey?: string;
                  PermissionName?: string;
                  WebExtensionId?: number;
                  WebExtensionPermissionId?: number;
              }[];
          },
      >

    • Parameters

      Returns Promise<
          {
              BinaryExtensionPermissions?: {
                  ExtensionGuid?: string;
                  ExtensionName?: string;
                  ExtensionPermissionId?: number;
                  PermissionId?: number;
                  PermissionName?: string;
              }[];
              Name?: string;
              Permissions?: {
                  AlertsDeleteAll?: boolean;
                  AlertsUpdate?: boolean;
                  ClassConfig?: boolean;
                  ClientDelete?: boolean;
                  ClientEdit?: boolean;
                  ClientRead?: boolean;
                  ClientsShowAll?: boolean;
                  ComputersCreate?: boolean;
                  ComputersDelete?: boolean;
                  ComputersForceUpdate?: boolean;
                  ComputersShowAll?: boolean;
                  ComputersUpdate?: boolean;
                  ConfigApplicationList?: boolean;
                  ConfigEventBlackList?: boolean;
                  ContactDelete?: boolean;
                  ContactEdit?: boolean;
                  ContactRead?: boolean;
                  CreateTickets?: boolean;
                  DashboardConfig?: boolean;
                  DashManage?: boolean;
                  DashOverview?: boolean;
                  DashTicketing?: boolean;
                  DashTime?: boolean;
                  DashTrending?: boolean;
                  DatabaseExecute?: boolean;
                  DataViewDelete?: boolean;
                  DataViewShowAll?: boolean;
                  DataViewUpdate?: boolean;
                  GroupInfoUpdate?: boolean;
                  GroupManagedServices?: boolean;
                  GroupMonitorsUpdate?: boolean;
                  GroupsCreate?: boolean;
                  GroupsDelete?: boolean;
                  GroupsScheduleScript?: boolean;
                  GroupsShowAll?: boolean;
                  HUDShowAll?: boolean;
                  HUDUpdate?: boolean;
                  InternalMonitorsCreate?: boolean;
                  InternalMonitorsDelete?: boolean;
                  InternalMonitorsUpdate?: boolean;
                  LanguagePackEditor?: boolean;
                  LinksDelete?: boolean;
                  LocationsShowAll?: boolean;
                  ManageAudits?: boolean;
                  ManagedServiceCatalog?: boolean;
                  ManageGroups?: boolean;
                  ManageOfflineComputers?: boolean;
                  ManageOutdated?: boolean;
                  ManageRemoteCommands?: boolean;
                  ManageScheduleClientScripts?: boolean;
                  ManageServiceLogs?: boolean;
                  NavigationMenuUpdate?: boolean;
                  NetworkDeviceDelete?: boolean;
                  NetworkDeviceShowAll?: boolean;
                  NetworkDeviceUpdate?: boolean;
                  PatchManagerConfig?: boolean;
                  PatchManagerRead?: boolean;
                  PatchManagerUpdate?: boolean;
                  PermissionsUpdate?: boolean;
                  PluginManager?: boolean;
                  ProbeTemplateExecute?: boolean;
                  QuickConnect?: boolean;
                  RemoteMonitorsCreate?: boolean;
                  RemoteMonitorsDelete?: boolean;
                  ReportDelete?: boolean;
                  ReportEdit?: boolean;
                  ReportRead?: boolean;
                  ReportsCreate?: boolean;
                  RetiredAssetsDelete?: boolean;
                  RSSFeedRead?: boolean;
                  RSSFeedUpdate?: boolean;
                  ScheduledScriptsUpdate?: boolean;
                  ScriptDelete?: boolean;
                  ScriptEdit?: boolean;
                  ScriptRead?: boolean;
                  SearchesDelete?: boolean;
                  SearchesRead?: boolean;
                  SearchesUpdate?: boolean;
                  ServerStatus?: boolean;
                  SharedLinks?: boolean;
                  ShowPasswords?: boolean;
                  SolutionCenter?: boolean;
                  SQLScriptFunctions?: boolean;
                  SuperAdmin?: boolean;
                  SystemConfig?: boolean;
                  TemplateDelete?: boolean;
                  TemplateEdit?: boolean;
                  TemplateRead?: boolean;
                  TicketsDelete?: boolean;
                  TicketsRead?: boolean;
                  TicketsRequest?: boolean;
                  TicketsUpdate?: boolean;
                  ToolDelete?: boolean;
                  ToolEdit?: boolean;
                  ToolRead?: boolean;
                  UserClassCreate?: boolean;
                  UserClassDelete?: boolean;
                  UserClassRead?: boolean;
                  UserClassUpdate?: boolean;
                  UserDelete?: boolean;
                  UserEdit?: boolean;
                  UserRead?: boolean;
                  UsersShowAll?: boolean;
              };
              UserClassId?: number;
              WebExtensionClaims?: {
                  Description?: string;
                  PermissionKey?: string;
                  PermissionName?: string;
                  WebExtensionId?: number;
                  WebExtensionPermissionId?: number;
              }[];
          }[],
      >

    • Parameters

      • userClassId: number

      Returns Promise<
          {
              ExtensionClaims?: {
                  Description?: string;
                  DisplayName?: string;
                  ExtensionClaimTypeId?: number;
                  IsAssigned?: boolean;
                  IsDefaultClaim?: boolean;
              }[];
              WebExtensionId?: number;
              WebExtensionName?: string;
          }[],
      >

    • Parameters

      • userId: number

      Returns Promise<
          {
              PluginPermissions?: {
                  ExtensionGuid?: string;
                  ExtensionName?: string;
                  ExtensionPermissionId?: number;
                  HasPermission?: boolean;
                  PermissionId?: number;
                  PermissionName?: string;
              }[];
              UserId?: number;
              UserPermissions?: string[];
              WebExtensionClaims?: {
                  ClaimKey?: string;
                  Description?: string;
                  DisplayName?: string;
                  ExtensionClaimTypeId?: number;
                  HasClaim?: boolean;
                  WebExtensionId?: number;
              }[];
          },
      >

    • Parameters

      • userId: number
      • PatchOperationArray: {
            content: {
                "application/json": {
                    Op?: string;
                    Path?: string;
                    Value?: Record<string, never>;
                }[];
                "application/x-www-form-urlencoded": {
                    Op?: string;
                    Path?: string;
                    Value?: Record<string, never>;
                }[];
                "application/xml": {
                    Op?: string;
                    Path?: string;
                    Value?: Record<string, never>;
                }[];
                "text/json": { Op?: string; Path?: string; Value?: Record<string, never> }[];
                "text/xml": { Op?: string; Path?: string; Value?: Record<string, never> }[];
            };
        }

      Returns Promise<
          {
              AllowLegacyApiAccess?: boolean;
              AssociatedGroups?: {
                  AutoJoinSettings?: {
                      ComputerSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                      };
                      ContactSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                          ShouldIncludeAssociatedComputers?: boolean;
                      };
                      NetworkDeviceSearchSettings?: {
                          AutoJoinSearchId?: number;
                          IsLimitedToSearch?: boolean;
                          Name?: string;
                      };
                  };
                  Description?: string;
                  FullName?: string;
                  GroupId?: number;
                  GroupType?: { GroupTypeId?: number; Name?: string };
                  LinkingSettings?: {
                      GroupLinkTypeId?: number;
                      GroupLinkTypeName?: string;
                      IsSynchronized?: boolean;
                      LinkedEntityId?: number;
                      LinkedEntityName?: string;
                  };
                  MaintenanceWindowSettings?: {
                      MaintenanceWindowId?: number;
                      Name?: string;
                  };
                  MasterStatus?: { MasterStatusTypeId?: number; Name?: string };
                  Name?: string;
                  TemplateSettings?: {
                      Priority?: number;
                      RemoteAgentTemplate?: { Name?: string; RemoteAgentTemplateId?: number };
                  };
              }[];
              AuditingLevel?: number;
              CommandLevel?: number;
              EmailAddress?: string;
              FirstName?: string;
              Folder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: number };
              IsIntegrator?: boolean;
              IsLocked?: boolean;
              IsTicketRouter?: boolean;
              IsTicketSupervisor?: boolean;
              LastName?: string;
              LastSuccessfulLogin?: string;
              LastUpdated?: string;
              Name?: string;
              NewTicketDisplayLimit?: number;
              OpenTicketLimit?: number;
              Password?: string;
              PrimaryClients?: { ClientId?: number; Name?: string }[];
              RequiresLoginReport?: boolean;
              RequiresLogoutReport?: boolean;
              SsoEmail?: string;
              SsoStatus?: { SsoStatusId?: number; StatusName?: string };
              TicketLevel?: { Name?: string; TicketLevelId?: number };
              UserClasses?: {
                  BinaryExtensionPermissions?: {
                      ExtensionGuid?: string;
                      ExtensionName?: string;
                      ExtensionPermissionId?: number;
                      PermissionId?: number;
                      PermissionName?: string;
                  }[];
                  Name?: string;
                  Permissions?: {
                      AlertsDeleteAll?: boolean;
                      AlertsUpdate?: boolean;
                      ClassConfig?: boolean;
                      ClientDelete?: boolean;
                      ClientEdit?: boolean;
                      ClientRead?: boolean;
                      ClientsShowAll?: boolean;
                      ComputersCreate?: boolean;
                      ComputersDelete?: boolean;
                      ComputersForceUpdate?: boolean;
                      ComputersShowAll?: boolean;
                      ComputersUpdate?: boolean;
                      ConfigApplicationList?: boolean;
                      ConfigEventBlackList?: boolean;
                      ContactDelete?: boolean;
                      ContactEdit?: boolean;
                      ContactRead?: boolean;
                      CreateTickets?: boolean;
                      DashboardConfig?: boolean;
                      DashManage?: boolean;
                      DashOverview?: boolean;
                      DashTicketing?: boolean;
                      DashTime?: boolean;
                      DashTrending?: boolean;
                      DatabaseExecute?: boolean;
                      DataViewDelete?: boolean;
                      DataViewShowAll?: boolean;
                      DataViewUpdate?: boolean;
                      GroupInfoUpdate?: boolean;
                      GroupManagedServices?: boolean;
                      GroupMonitorsUpdate?: boolean;
                      GroupsCreate?: boolean;
                      GroupsDelete?: boolean;
                      GroupsScheduleScript?: boolean;
                      GroupsShowAll?: boolean;
                      HUDShowAll?: boolean;
                      HUDUpdate?: boolean;
                      InternalMonitorsCreate?: boolean;
                      InternalMonitorsDelete?: boolean;
                      InternalMonitorsUpdate?: boolean;
                      LanguagePackEditor?: boolean;
                      LinksDelete?: boolean;
                      LocationsShowAll?: boolean;
                      ManageAudits?: boolean;
                      ManagedServiceCatalog?: boolean;
                      ManageGroups?: boolean;
                      ManageOfflineComputers?: boolean;
                      ManageOutdated?: boolean;
                      ManageRemoteCommands?: boolean;
                      ManageScheduleClientScripts?: boolean;
                      ManageServiceLogs?: boolean;
                      NavigationMenuUpdate?: boolean;
                      NetworkDeviceDelete?: boolean;
                      NetworkDeviceShowAll?: boolean;
                      NetworkDeviceUpdate?: boolean;
                      PatchManagerConfig?: boolean;
                      PatchManagerRead?: boolean;
                      PatchManagerUpdate?: boolean;
                      PermissionsUpdate?: boolean;
                      PluginManager?: boolean;
                      ProbeTemplateExecute?: boolean;
                      QuickConnect?: boolean;
                      RemoteMonitorsCreate?: boolean;
                      RemoteMonitorsDelete?: boolean;
                      ReportDelete?: boolean;
                      ReportEdit?: boolean;
                      ReportRead?: boolean;
                      ReportsCreate?: boolean;
                      RetiredAssetsDelete?: boolean;
                      RSSFeedRead?: boolean;
                      RSSFeedUpdate?: boolean;
                      ScheduledScriptsUpdate?: boolean;
                      ScriptDelete?: boolean;
                      ScriptEdit?: boolean;
                      ScriptRead?: boolean;
                      SearchesDelete?: boolean;
                      SearchesRead?: boolean;
                      SearchesUpdate?: boolean;
                      ServerStatus?: boolean;
                      SharedLinks?: boolean;
                      ShowPasswords?: boolean;
                      SolutionCenter?: boolean;
                      SQLScriptFunctions?: boolean;
                      SuperAdmin?: boolean;
                      SystemConfig?: boolean;
                      TemplateDelete?: boolean;
                      TemplateEdit?: boolean;
                      TemplateRead?: boolean;
                      TicketsDelete?: boolean;
                      TicketsRead?: boolean;
                      TicketsRequest?: boolean;
                      TicketsUpdate?: boolean;
                      ToolDelete?: boolean;
                      ToolEdit?: boolean;
                      ToolRead?: boolean;
                      UserClassCreate?: boolean;
                      UserClassDelete?: boolean;
                      UserClassRead?: boolean;
                      UserClassUpdate?: boolean;
                      UserDelete?: boolean;
                      UserEdit?: boolean;
                      UserRead?: boolean;
                      UsersShowAll?: boolean;
                  };
                  UserClassId?: number;
                  WebExtensionClaims?: {
                      Description?: string;
                      PermissionKey?: string;
                      PermissionName?: string;
                      WebExtensionId?: number;
                      WebExtensionPermissionId?: number;
                  }[];
              }[];
              UserId?: number;
              UsesTicketBasedSecurity?: boolean;
          },
      >

    • Parameters

      • userFolderId: number
      • PatchOperationArray: {
            content: {
                "application/json": {
                    Op?: string;
                    Path?: string;
                    Value?: Record<string, never>;
                }[];
                "application/x-www-form-urlencoded": {
                    Op?: string;
                    Path?: string;
                    Value?: Record<string, never>;
                }[];
                "application/xml": {
                    Op?: string;
                    Path?: string;
                    Value?: Record<string, never>;
                }[];
                "text/json": { Op?: string; Path?: string; Value?: Record<string, never> }[];
                "text/xml": { Op?: string; Path?: string; Value?: Record<string, never> }[];
            };
        }

      Returns Promise<{ IsSsoEnabled?: boolean; Name?: string; UserFolderId?: number }>

    post

    • post(
          TokenCredentials: {
              Password?: string;
              TwoFactorPasscode?: string;
              Username?: string;
          },
      ): Promise<
          {
              AbsoluteExpirationDate?: string;
              AccessToken?: string;
              ExpirationDate?: string;
              InternalUserName?: string;
              IsInternalTwoFactorRequired?: boolean;
              IsTwoFactorRequired?: boolean;
              SSOAccessToken?: string;
              TokenType?: string;
              UserId?: string;
          },
      >

      Parameters

      • TokenCredentials: { Password?: string; TwoFactorPasscode?: string; Username?: string }

      Returns Promise<
          {
              AbsoluteExpirationDate?: string;
              AccessToken?: string;
              ExpirationDate?: string;
              InternalUserName?: string;
              IsInternalTwoFactorRequired?: boolean;
              IsTwoFactorRequired?: boolean;
              SSOAccessToken?: string;
              TokenType?: string;
              UserId?: string;
          },
      >

    • Parameters

      • userId: number
      • AuthServiceCredentials: {
            ServiceId?: number;
            ServiceToken?: string;
            TokenType?: "Undefined" | "IdentityToken" | "AccessToken";
        }
        • OptionalServiceId?: number

          Format: int32

        • OptionalServiceToken?: string
        • OptionalTokenType?: "Undefined" | "IdentityToken" | "AccessToken"

      Returns Promise<
          {
              ServiceId?: number;
              ServiceToken?: string;
              TokenType?: "Undefined"
              | "IdentityToken"
              | "AccessToken";
          },
      >

    • Parameters

      • FeatureFlag: { Id?: number; IsEnabled?: boolean; Name?: string }
        • OptionalId?: number

          Format: int32

        • OptionalIsEnabled?: boolean
        • OptionalName?: string

      Returns Promise<{ Id?: number; IsEnabled?: boolean; Name?: string }>

    • Parameters

      • UserAudit: {
            AuditAction?: {
                ExtensionName?: string;
                Id?: number;
                Level?: number;
                Name?: string;
            };
            DateCreated?: string;
            ExternalId?: number;
            Id?: number;
            Message?: string;
            SecondaryIdentifier?: string;
            Source?: { Id?: number; Name?: string };
            User?: {
                EmailAddress?: string;
                Folder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: string };
                Name?: string;
                SsoStatus?: { SsoStatusId?: number; StatusName?: string };
                UserId?: string;
            };
        }
        • OptionalAuditAction?: { ExtensionName?: string; Id?: number; Level?: number; Name?: string }
          • OptionalExtensionName?: string
          • OptionalId?: number

            Format: int32

          • OptionalLevel?: number

            Format: int32

          • OptionalName?: string
        • OptionalDateCreated?: string

          Format: date-time

        • OptionalExternalId?: number

          Format: int32

        • OptionalId?: number

          Format: int32

        • OptionalMessage?: string
        • OptionalSecondaryIdentifier?: string
        • OptionalSource?: { Id?: number; Name?: string }
          • OptionalId?: number

            Format: int32

          • OptionalName?: string
        • OptionalUser?: {
              EmailAddress?: string;
              Folder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: string };
              Name?: string;
              SsoStatus?: { SsoStatusId?: number; StatusName?: string };
              UserId?: string;
          }
          • OptionalEmailAddress?: string
          • OptionalFolder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: string }
          • OptionalName?: string
          • OptionalSsoStatus?: { SsoStatusId?: number; StatusName?: string }
            • OptionalSsoStatusId?: number

              Format: int32

            • OptionalStatusName?: string
          • OptionalUserId?: string

      Returns Promise<
          {
              AuditAction?: {
                  ExtensionName?: string;
                  Id?: number;
                  Level?: number;
                  Name?: string;
              };
              DateCreated?: string;
              ExternalId?: number;
              Id?: number;
              Message?: string;
              SecondaryIdentifier?: string;
              Source?: { Id?: number; Name?: string };
              User?: {
                  EmailAddress?: string;
                  Folder?: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: string };
                  Name?: string;
                  SsoStatus?: { SsoStatusId?: number; StatusName?: string };
                  UserId?: string;
              };
          },
      >

    • Parameters

      • userId: number
      • UserFavorite: {
            AdditionalIdentifier?: string;
            Id?: number;
            ItemGUID?: string;
            Order?: number;
            UserId?: number;
        }
        • OptionalAdditionalIdentifier?: string
        • OptionalId?: number

          Format: int32

        • OptionalItemGUID?: string
        • OptionalOrder?: number

          Format: int32

        • OptionalUserId?: number

          Format: int32

      Returns Promise<
          {
              AdditionalIdentifier?: string;
              Id?: number;
              ItemGUID?: string;
              Order?: number;
              UserId?: number;
          },
      >

    • Parameters

      • UserFolder: { IsSsoEnabled?: boolean; Name?: string; UserFolderId?: number }
        • OptionalIsSsoEnabled?: boolean
        • OptionalName?: string
        • OptionalUserFolderId?: number

          Format: int32

      Returns Promise<{ IsSsoEnabled?: boolean; Name?: string; UserFolderId?: number }>

    • Parameters

      • userId: number
      • UserSetting: { Name?: string; UserId?: number; Value?: string }
        • OptionalName?: string
        • OptionalUserId?: number

          Format: int32

        • OptionalValue?: string

      Returns Promise<{ Name?: string; UserId?: number; Value?: string }>

    • Parameters

      • userClassId: number
      • UserClassWebExtensionRequest: {
            AssignedExtensions?: {
                AssignedClaims?: number[];
                WebExtensionId?: number;
            }[];
        }

      Returns Promise<
          {
              ExtensionClaims?: {
                  Description?: string;
                  DisplayName?: string;
                  ExtensionClaimTypeId?: number;
                  IsAssigned?: boolean;
                  IsDefaultClaim?: boolean;
              }[];
              WebExtensionId?: number;
              WebExtensionName?: string;
          }[],
      >

    • Parameters

      • RefreshBearerTokenAsyncTokentext: {
            content: {
                "application/json": string;
                "application/x-www-form-urlencoded": string;
                "application/xml": string;
                "text/json": string;
                "text/xml": string;
            };
        }

      Returns Promise<
          {
              AbsoluteExpirationDate?: string;
              AccessToken?: string;
              ExpirationDate?: string;
              InternalUserName?: string;
              IsInternalTwoFactorRequired?: boolean;
              IsTwoFactorRequired?: boolean;
              SSOAccessToken?: string;
              TokenType?: string;
              UserId?: string;
          },
      >

    Settings

    Member Visibility

    On This Page

    Methods