{"id":20471865,"url":"https://github.com/signiant/api_client_manager_agents_node","last_synced_at":"2025-03-05T13:45:29.260Z","repository":{"id":93379492,"uuid":"407679551","full_name":"Signiant/api_client_manager_agents_node","owner":"Signiant","description":"Signiant Manager+Agents provides a REST API to automate user management, user group, agent groups, jobs, resource controls, and job groups.","archived":false,"fork":false,"pushed_at":"2021-09-17T21:08:54.000Z","size":88,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-16T02:24:22.909Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Signiant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-17T21:06:32.000Z","updated_at":"2021-09-17T21:08:57.000Z","dependencies_parsed_at":"2023-07-03T19:43:02.619Z","dependency_job_id":null,"html_url":"https://github.com/Signiant/api_client_manager_agents_node","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Signiant%2Fapi_client_manager_agents_node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Signiant%2Fapi_client_manager_agents_node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Signiant%2Fapi_client_manager_agents_node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Signiant%2Fapi_client_manager_agents_node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Signiant","download_url":"https://codeload.github.com/Signiant/api_client_manager_agents_node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242039588,"owners_count":20061925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T14:17:27.210Z","updated_at":"2025-03-05T13:45:29.254Z","avatar_url":"https://github.com/Signiant.png","language":"JavaScript","readme":"# Manager+Agents API\n\nManageragentsApi - JavaScript client for manageragents_api\nSigniant Manager+Agents provides a REST API to automate user management, user group, agent groups, jobs, resource controls, and job groups. \nThis SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 14.1.0\n- Package version: 14.1.0\n- Build package: io.swagger.codegen.languages.JavascriptClientCodegen\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nTo publish the library as a [npm](https://www.npmjs.com/),\nplease follow the procedure in [\"Publishing npm packages\"](https://docs.npmjs.com/getting-started/publishing-npm-packages).\n\nThen install it via:\n\n```shell\nnpm install manageragents_api --save\n```\n\n##### Local development\n\nTo use the library locally without publishing to a remote npm registry, first install the dependencies by changing \ninto the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nFinally, switch to the directory you want to use your manageragents_api from, and run:\n\n```shell\nnpm link /path/to/\u003cJAVASCRIPT_CLIENT_DIR\u003e\n```\n\nYou should now be able to `require('manageragents_api')` in javascript files from the directory you ran the last \ncommand above from.\n\n#### git\n#\nIf the library is hosted at a git repository, e.g.\nhttps://github.com/YOUR_USERNAME/manageragents_api\nthen install it via:\n\n```shell\n    npm install YOUR_USERNAME/manageragents_api --save\n```\n\n### For browser\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/). After following\nthe above steps with Node.js and installing browserify with `npm install -g browserify`,\nperform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually \nuse this library):\n\n```shell\nbrowserify main.js \u003e bundle.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar ManageragentsApi = require('manageragents_api');\n\nvar api = new ManageragentsApi.AgentGroupsApi()\n\nvar username = \"username_example\"; // {String} Administrator user name.\n\nvar password = \"password_example\"; // {String} Administrator password.\n\nvar opts = { \n  'jSONForCreateAgentGroup': new ManageragentsApi.AgentGroup() // {AgentGroup} \n};\n\nvar callback = function(error, data, response) {\n  if (error) {\n    console.error(error);\n  } else {\n    console.log('API called successfully. Returned data: ' + data);\n  }\n};\napi.createAgentGroup(username, password, opts, callback);\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://manager.url/signiant/spring/admin/v1.0*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ManageragentsApi.AgentGroupsApi* | [**createAgentGroup**](docs/AgentGroupsApi.md#createAgentGroup) | **POST** /agentgroups | Create agent group\n*ManageragentsApi.AgentGroupsApi* | [**deleteAgentGroup**](docs/AgentGroupsApi.md#deleteAgentGroup) | **DELETE** /agentgroups/{agentgroupname|agentgroupID} | Delete agent group\n*ManageragentsApi.AgentGroupsApi* | [**editAgentGroup**](docs/AgentGroupsApi.md#editAgentGroup) | **PUT** /agentgroups | Edit agent group\n*ManageragentsApi.AgentGroupsApi* | [**getAgentGroup**](docs/AgentGroupsApi.md#getAgentGroup) | **GET** /agentgroups/{agentgroupname|agentgroupID} | View Agent Group\n*ManageragentsApi.AgentGroupsApi* | [**getAgentGroups**](docs/AgentGroupsApi.md#getAgentGroups) | **GET** /listagentgroups | List all agent groups\n*ManageragentsApi.AgentsApi* | [**getAgent**](docs/AgentsApi.md#getAgent) | **GET** /listagents | List agents\n*ManageragentsApi.AgentsApi* | [**revokeCertificate**](docs/AgentsApi.md#revokeCertificate) | **POST** /certificate/revoke | Revoke certificate\n*ManageragentsApi.JobGroupsApi* | [**createJobGroup**](docs/JobGroupsApi.md#createJobGroup) | **POST** /jobgroups | Create job group\n*ManageragentsApi.JobGroupsApi* | [**deleteJobGroup**](docs/JobGroupsApi.md#deleteJobGroup) | **DELETE** /jobgroups/{jobgroupname|jobgroupID} | Delete job group\n*ManageragentsApi.JobGroupsApi* | [**editJobGroup**](docs/JobGroupsApi.md#editJobGroup) | **PUT** /jobgroups | Edit a job group\n*ManageragentsApi.JobGroupsApi* | [**getJobGroup**](docs/JobGroupsApi.md#getJobGroup) | **GET** /jobgroups/{jobgroupname|jobgroupID} | Get job group by name or by jobGroupID\n*ManageragentsApi.JobGroupsApi* | [**listJobGroups**](docs/JobGroupsApi.md#listJobGroups) | **GET** /listjobgroups | List all job groups\n*ManageragentsApi.JobsApi* | [**addJobVariable**](docs/JobsApi.md#addJobVariable) | **POST** /jobs/variables/{jobname}/{jobgroup} | Edit or add job arguments/variables for a specified job\n*ManageragentsApi.JobsApi* | [**commandsForJob**](docs/JobsApi.md#commandsForJob) | **GET** /jobs/command/{jobname}/{jobgroupname|jobgroupID}/{command} | Send commands to a job\n*ManageragentsApi.JobsApi* | [**createJob**](docs/JobsApi.md#createJob) | **POST** /jobs | Create new job\n*ManageragentsApi.JobsApi* | [**deleteJob**](docs/JobsApi.md#deleteJob) | **DELETE** /jobs/{jobname}/{jobgroupname|jobgroupID} | Soft delete a job by name or ID\n*ManageragentsApi.JobsApi* | [**getFileLogWithRunNumber**](docs/JobsApi.md#getFileLogWithRunNumber) | **GET** /jobs/filelog/{jobName}/{jobGroupName|jobGroupID}/{runNumber} | View the file log for a job in some job group for a specific job run\n*ManageragentsApi.JobsApi* | [**getJob**](docs/JobsApi.md#getJob) | **GET** /jobs/{jobname}/{jobgroupname|jobgroupID} | View job by name\n*ManageragentsApi.JobsApi* | [**getJobByID**](docs/JobsApi.md#getJobByID) | **GET** /jobs/{jobID} | View job by job ID\n*ManageragentsApi.JobsApi* | [**getJobFileLog**](docs/JobsApi.md#getJobFileLog) | **GET** /jobs/filelog/{jobName}/{jobGroupName|jobGroupID} | View the file log for a job in some job group\n*ManageragentsApi.JobsApi* | [**getJobLog**](docs/JobsApi.md#getJobLog) | **GET** /jobs/joblog/{jobName}/{jobGroupName} | View the job log for a job in some job group\n*ManageragentsApi.JobsApi* | [**getJobLogWithRunNumber**](docs/JobsApi.md#getJobLogWithRunNumber) | **GET** /jobs/joblog/{jobName}/{jobGroupName}/{runNumber} | View the job log for a job in some job group for a specific job run\n*ManageragentsApi.JobsApi* | [**getJobView**](docs/JobsApi.md#getJobView) | **GET** /jobs/jobview/{jobviewname|jobviewID} | Get a job view by job view name or job view ID\n*ManageragentsApi.JobsApi* | [**getListJobs**](docs/JobsApi.md#getListJobs) | **GET** /listjobs/{jobgroupname|jobgroupID} | Get a list of jobs from a specified job group\n*ManageragentsApi.JobsApi* | [**getStatsLog**](docs/JobsApi.md#getStatsLog) | **GET** /jobs/statslog/{jobName}/{jobGroupName|jobGroupID} | View the statistic log for a job in some job group\n*ManageragentsApi.JobsApi* | [**getStatsLogWithRunNumber**](docs/JobsApi.md#getStatsLogWithRunNumber) | **GET** /jobs/statslog/{jobName}/{jobGroupName|jobGroupID}/{runNumber} | View the statistic log for a job in some job group for a specific job run\n*ManageragentsApi.JobsApi* | [**hardDeleteJob**](docs/JobsApi.md#hardDeleteJob) | **DELETE** /jobs | Hard Delete a job by ID or name\n*ManageragentsApi.JobsApi* | [**statsJob**](docs/JobsApi.md#statsJob) | **POST** /jobs/stats/{jobname}/{jobgroupname|jobgroupID} | Request specific statistics from a job by group name or group ID\n*ManageragentsApi.JobsApi* | [**statsRunNumberJob**](docs/JobsApi.md#statsRunNumberJob) | **POST** /jobs/stats/{jobname}/{jobgroupname|jobgroupID}/{runnumber} | Request specific statistics from a job with a group name or group ID by run number\n*ManageragentsApi.JobsApi* | [**updateJob**](docs/JobsApi.md#updateJob) | **PUT** /jobs | Edit job\n*ManageragentsApi.ObjectStorageProfilesApi* | [**createObjectStorageProfile**](docs/ObjectStorageProfilesApi.md#createObjectStorageProfile) | **POST** /storageprofiles | Create Local S3 object storage profile\n*ManageragentsApi.ObjectStorageProfilesApi* | [**deleteStorageProfile**](docs/ObjectStorageProfilesApi.md#deleteStorageProfile) | **DELETE** /storageprofiles/{storageprofilename|storageprofileID} | Delete Local S3/Azure/AWS S3 object storage profile\n*ManageragentsApi.ObjectStorageProfilesApi* | [**editObjectStorageProfile**](docs/ObjectStorageProfilesApi.md#editObjectStorageProfile) | **PUT** /storageprofiles | Edit Local S3 object storage profile\n*ManageragentsApi.ObjectStorageProfilesApi* | [**getListStorageProfiles**](docs/ObjectStorageProfilesApi.md#getListStorageProfiles) | **GET** /liststorageprofiles | Get a list of all object storage profiles\n*ManageragentsApi.ObjectStorageProfilesApi* | [**getLocalS3StorageProfile**](docs/ObjectStorageProfilesApi.md#getLocalS3StorageProfile) | **GET** /storageprofiles/{storageprofilename|storageprofileID} | Get Local S3 Storage Profile by name or storage profile ID\n*ManageragentsApi.ResourceControlsApi* | [**activateResourceControl**](docs/ResourceControlsApi.md#activateResourceControl) | **POST** /activateresourcecontrols | Activate resource control\n*ManageragentsApi.ResourceControlsApi* | [**createResourceControl**](docs/ResourceControlsApi.md#createResourceControl) | **POST** /resourcecontrols | Create resource control\n*ManageragentsApi.ResourceControlsApi* | [**deactivateResourceControl**](docs/ResourceControlsApi.md#deactivateResourceControl) | **POST** /deactivateresourcecontrols | Deactivate resource control\n*ManageragentsApi.ResourceControlsApi* | [**deleteResourceControl**](docs/ResourceControlsApi.md#deleteResourceControl) | **DELETE** /resourcecontrols/resourcecontrolname|resourcecontrolID | Delete resource control\n*ManageragentsApi.ResourceControlsApi* | [**editResourceControl**](docs/ResourceControlsApi.md#editResourceControl) | **PUT** /resourcecontrols | Edit a resource control\n*ManageragentsApi.ResourceControlsApi* | [**getConsumersResourceControl**](docs/ResourceControlsApi.md#getConsumersResourceControl) | **GET** /listresourcecontrolqueue/resourcecontrolname|resourcecontrolID | List of all consumers by name or ID for a specified resource control.\n*ManageragentsApi.ResourceControlsApi* | [**getresourceControl**](docs/ResourceControlsApi.md#getresourceControl) | **GET** /resourcecontrols/resourcecontrolname|resourcecontrolID | View a specific resource control\n*ManageragentsApi.ResourceControlsApi* | [**listresourcecontrols**](docs/ResourceControlsApi.md#listresourcecontrols) | **GET** /listresourcecontrols | List all Resource Controls\n*ManageragentsApi.ResourceControlsApi* | [**moveAgentResourceControl**](docs/ResourceControlsApi.md#moveAgentResourceControl) | **GET** /resourceontrols/move/consumerID/value | Move jobs in the Agent|MediaExchange resource control queue.\n*ManageragentsApi.ResourceControlsApi* | [**moveJobResourceControl**](docs/ResourceControlsApi.md#moveJobResourceControl) | **GET** /resourcecontrols/move/jobname|jobID/jobgroupname/value | Move jobs in resource control queue.\n*ManageragentsApi.UserGroupsApi* | [**createUserGroup**](docs/UserGroupsApi.md#createUserGroup) | **POST** /usergroups | Create a user group\n*ManageragentsApi.UserGroupsApi* | [**deleteUserGroup**](docs/UserGroupsApi.md#deleteUserGroup) | **DELETE** /usergroups/{groupname|groupID} | Delete a user group by name or by groupID\n*ManageragentsApi.UserGroupsApi* | [**editUserGroup**](docs/UserGroupsApi.md#editUserGroup) | **PUT** /usergroups | Edit a user group\n*ManageragentsApi.UserGroupsApi* | [**getUserGroup**](docs/UserGroupsApi.md#getUserGroup) | **GET** /usergroups/{groupname|groupID} | Get a user group by name or by groupID\n*ManageragentsApi.UserGroupsApi* | [**listUserGroups**](docs/UserGroupsApi.md#listUserGroups) | **GET** /listusergroups | Get a list of user groups\n*ManageragentsApi.UsersApi* | [**activateUser**](docs/UsersApi.md#activateUser) | **POST** /activateusers | Activate user\n*ManageragentsApi.UsersApi* | [**changePassword**](docs/UsersApi.md#changePassword) | **POST** /changepassword | Change user password\n*ManageragentsApi.UsersApi* | [**createUser**](docs/UsersApi.md#createUser) | **POST** /users | Create user\n*ManageragentsApi.UsersApi* | [**deactivateUser**](docs/UsersApi.md#deactivateUser) | **POST** /deactivateusers | Deactivate user\n*ManageragentsApi.UsersApi* | [**deleteUser**](docs/UsersApi.md#deleteUser) | **DELETE** /users/{username|userID} | Delete user by username or userID\n*ManageragentsApi.UsersApi* | [**editUser**](docs/UsersApi.md#editUser) | **PUT** /users | Edit user\n*ManageragentsApi.UsersApi* | [**getUser**](docs/UsersApi.md#getUser) | **GET** /users/{username|userID} | Get user by username or userID\n*ManageragentsApi.UsersApi* | [**listusers**](docs/UsersApi.md#listusers) | **GET** /listusers | List all users\n\n\n## Documentation for Models\n\n - [ManageragentsApi.AccessAcl](docs/AccessAcl.md)\n - [ManageragentsApi.AccessAcls](docs/AccessAcls.md)\n - [ManageragentsApi.ActivateDeactivateResourceControl](docs/ActivateDeactivateResourceControl.md)\n - [ManageragentsApi.ActivateDeactivateResourceControlsResponse](docs/ActivateDeactivateResourceControlsResponse.md)\n - [ManageragentsApi.ActivateDeactivateUserResponse](docs/ActivateDeactivateUserResponse.md)\n - [ManageragentsApi.ActivateUser](docs/ActivateUser.md)\n - [ManageragentsApi.AddAgentGroupMembers](docs/AddAgentGroupMembers.md)\n - [ManageragentsApi.AgentGroup](docs/AgentGroup.md)\n - [ManageragentsApi.AgentGroups](docs/AgentGroups.md)\n - [ManageragentsApi.AgentGroupsObject](docs/AgentGroupsObject.md)\n - [ManageragentsApi.Agents](docs/Agents.md)\n - [ManageragentsApi.ChangePassword](docs/ChangePassword.md)\n - [ManageragentsApi.CreateAWSS3StorageProfile](docs/CreateAWSS3StorageProfile.md)\n - [ManageragentsApi.CreateAgentGroupResponse](docs/CreateAgentGroupResponse.md)\n - [ManageragentsApi.CreateAzureStorageProfile](docs/CreateAzureStorageProfile.md)\n - [ManageragentsApi.CreateJobGroupResponse](docs/CreateJobGroupResponse.md)\n - [ManageragentsApi.CreateJobResponse](docs/CreateJobResponse.md)\n - [ManageragentsApi.CreateObjectStorageResponse](docs/CreateObjectStorageResponse.md)\n - [ManageragentsApi.CreateResourceControlResponse](docs/CreateResourceControlResponse.md)\n - [ManageragentsApi.CreateS3StorageProfile](docs/CreateS3StorageProfile.md)\n - [ManageragentsApi.CreateUserGroupResponse](docs/CreateUserGroupResponse.md)\n - [ManageragentsApi.CreateUserResponse](docs/CreateUserResponse.md)\n - [ManageragentsApi.DeactivateUser](docs/DeactivateUser.md)\n - [ManageragentsApi.DeleteJob](docs/DeleteJob.md)\n - [ManageragentsApi.EditJob](docs/EditJob.md)\n - [ManageragentsApi.EditS3StorageProfile](docs/EditS3StorageProfile.md)\n - [ManageragentsApi.FileLog](docs/FileLog.md)\n - [ManageragentsApi.GetAgentGroup](docs/GetAgentGroup.md)\n - [ManageragentsApi.GetAgentGroupsObject](docs/GetAgentGroupsObject.md)\n - [ManageragentsApi.GetJob](docs/GetJob.md)\n - [ManageragentsApi.GetS3StorageProfile](docs/GetS3StorageProfile.md)\n - [ManageragentsApi.Job](docs/Job.md)\n - [ManageragentsApi.JobArgs](docs/JobArgs.md)\n - [ManageragentsApi.JobGroup](docs/JobGroup.md)\n - [ManageragentsApi.JobGroupResponse](docs/JobGroupResponse.md)\n - [ManageragentsApi.JobLog](docs/JobLog.md)\n - [ManageragentsApi.JobView](docs/JobView.md)\n - [ManageragentsApi.ListJobGroupsResponse](docs/ListJobGroupsResponse.md)\n - [ManageragentsApi.ListJobs](docs/ListJobs.md)\n - [ManageragentsApi.ListResourceControlQueueResponse](docs/ListResourceControlQueueResponse.md)\n - [ManageragentsApi.ListResourceControlsResponse](docs/ListResourceControlsResponse.md)\n - [ManageragentsApi.ListStorageProfiles](docs/ListStorageProfiles.md)\n - [ManageragentsApi.ListUserGroupsResponse](docs/ListUserGroupsResponse.md)\n - [ManageragentsApi.ListUsersResponse](docs/ListUsersResponse.md)\n - [ManageragentsApi.Members](docs/Members.md)\n - [ManageragentsApi.Menu](docs/Menu.md)\n - [ManageragentsApi.MxProperties](docs/MxProperties.md)\n - [ManageragentsApi.PutAgentGroupsObject](docs/PutAgentGroupsObject.md)\n - [ManageragentsApi.Relays](docs/Relays.md)\n - [ManageragentsApi.RemoveAgentGroupMembers](docs/RemoveAgentGroupMembers.md)\n - [ManageragentsApi.ResourceControl](docs/ResourceControl.md)\n - [ManageragentsApi.ResourceControlResponse](docs/ResourceControlResponse.md)\n - [ManageragentsApi.RevokeAgentCertificate](docs/RevokeAgentCertificate.md)\n - [ManageragentsApi.StatisticLog](docs/StatisticLog.md)\n - [ManageragentsApi.Stats](docs/Stats.md)\n - [ManageragentsApi.StatsResponse](docs/StatsResponse.md)\n - [ManageragentsApi.StorageProfile](docs/StorageProfile.md)\n - [ManageragentsApi.Success](docs/Success.md)\n - [ManageragentsApi.User](docs/User.md)\n - [ManageragentsApi.UserGroup](docs/UserGroup.md)\n - [ManageragentsApi.UserGroupResponse](docs/UserGroupResponse.md)\n - [ManageragentsApi.UserResponse](docs/UserResponse.md)\n\n\n## Documentation for Authorization\n\n All endpoints do not require authorization.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsigniant%2Fapi_client_manager_agents_node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsigniant%2Fapi_client_manager_agents_node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsigniant%2Fapi_client_manager_agents_node/lists"}