Access-manager-api NPM

access-manager-api

AccessManagerApi - JavaScript client for access-manager-api Access Manager ReST Interfaces. All returned objects are returned as child objects in the AMServiceDocument container. In addition, a Response object has the code attribute of SUCCESS if the response is successful. This API supports being called by Admins only. Delegated Admins are not supported. This SDK is automatically generated by the Swagger Codegen project:

API verion: V_1_0_0
Package version: V_1_0_0
Build date: 2016-03-25T18:36:20.277Z
Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install access-manager-api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/access-manager-api then install it via:

npm install YOUR_USERNAME/access-manager-api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var AccessManagerApi = require('access-manager-api');

var defaultClient = AccessManagerApi.ApiClient.default;

// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'

var api = new AccessManagerApi.AGClustersApi()

var resourceID = "resourceID_example"; // {String} The ID of the protected resource

var serviceID = "serviceID_example"; // {String} the proxy service ID

var proxyID = "proxyID_example"; // {String} the reverse proxy ID

var clusterID = "clusterID_example"; // {String} The Access Gateway Cluster ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteProtectedResource(resourceID, serviceID, proxyID, clusterID, callback);

Documentation for API Endpoints

All URIs are relative to https://10.204.130.17:2443/amsvc/v1

Class	Method	HTTP request	Description
AccessManagerApi.AGClustersApi	deleteProtectedResource	DELETE /agclusters/{clusterID}/reverseproxies/{proxyID}/proxyservices/{serviceID}/protectedresources/{resourceID}	Deletes one protected resources
AccessManagerApi.AGClustersApi	getAGClusterAlertsById	GET /agclusters/{clusterID}/alerts	Get the AG Cluster alerts
AccessManagerApi.AGClustersApi	getAGClusterById	GET /agclusters/{clusterID}	Get the specified Access Gateway Cluster by ID
AccessManagerApi.AGClustersApi	getAGClusterHealthById	GET /agclusters/{clusterID}/health	Get the AG Cluster health
AccessManagerApi.AGClustersApi	getAGClusterStatisticsById	GET /agclusters/{clusterID}/statistics	Get the AG Cluster statistics
AccessManagerApi.AGClustersApi	getAGClusters	GET /agclusters	Get a list of Access Gateway Clusters
AccessManagerApi.AGClustersApi	getAGDeviceAlertsById	GET /agclusters/{clusterID}/devices/{deviceID}/alerts	Get the AG Device alerts
AccessManagerApi.AGClustersApi	getAGDeviceById	GET /agclusters/{clusterID}/devices/{deviceID}	Get the specified AG Device from the AG Cluster
AccessManagerApi.AGClustersApi	getAGDeviceHealthById	GET /agclusters/{clusterID}/devices/{deviceID}/health	Get the AG Device health
AccessManagerApi.AGClustersApi	getAGDeviceStatisticsById	GET /agclusters/{clusterID}/devices/{deviceID}/statistics	Get the AG Device statistics
AccessManagerApi.AGClustersApi	getAGDevices	GET /agclusters/{clusterID}/devices	Get a list of AG Devices for the requested AG Cluster ID
AccessManagerApi.AGClustersApi	getProtectedResourceById	GET /agclusters/{clusterID}/reverseproxies/{proxyID}/proxyservices/{serviceID}/protectedresources/{resourceID}	Get a protected resource given the Resource ID and Proxy Service ID and Cluster ID
AccessManagerApi.AGClustersApi	getProtectedResources	GET /agclusters/{clusterID}/reverseproxies/{proxyID}/proxyservices/{serviceID}/protectedresources	Get a list of protected resources
AccessManagerApi.AGClustersApi	getProxyServiceById	GET /agclusters/{clusterID}/reverseproxies/{proxyID}/proxyservices/{serviceID}	Get the specified proxy service given the service ID and cluster ID
AccessManagerApi.AGClustersApi	getProxyServices	GET /agclusters/{clusterID}/reverseproxies/{proxyID}/proxyservices	Get a list of proxy services given the cluster ID
AccessManagerApi.AGClustersApi	getReverseProxies	GET /agclusters/{clusterID}/reverseproxies	Get a list of reverse proxies given the cluster ID
AccessManagerApi.AGClustersApi	getReverseProxyById	GET /agclusters/{clusterID}/reverseproxies/{proxyID}	Get the specified reverse proxy given the proxy ID and cluster ID
AccessManagerApi.AGClustersApi	postProtectedResource	POST /agclusters/{clusterID}/reverseproxies/{proxyID}/proxyservices/{serviceID}/protectedresources	Add new protected resource to list
AccessManagerApi.AGClustersApi	putProtectedResource	PUT /agclusters/{clusterID}/reverseproxies/{proxyID}/proxyservices/{serviceID}/protectedresources/{resourceID}	Update a current protected resource
AccessManagerApi.AGClustersApi	updateAGCluster	PUT /agclusters/{clusterID}	Update an AG Cluster
AccessManagerApi.AGClustersApi	updateAGDevice	PUT /agclusters/{clusterID}/devices/{deviceID}	Update an AG Cluster Device
AccessManagerApi.AdminConsolesApi	getAdminConsoleById	GET /adminconsoles/{consoleID}	Get an adminConsole by console ID
AccessManagerApi.AdminConsolesApi	getAdminConsoles	GET /adminconsoles	Get the list of known admin consoles
AccessManagerApi.AlertsApi	getAlerts	GET /alerts	Get system alerts
AccessManagerApi.ConnectorDefinitionsApi	addConnectorDefinition	POST /connectordefinitions	Add a connector definition to the definitions library
AccessManagerApi.ConnectorDefinitionsApi	deleteConnectorDefinition	DELETE /connectordefinitions/{definitionID}	Delete a ConnectorDefinition from the definitions library
AccessManagerApi.ConnectorDefinitionsApi	getConnectorDefinitionById	GET /connectordefinitions/{definitionID}	Get an connectordefinition from the library by connectordefinition instance ID
AccessManagerApi.ConnectorDefinitionsApi	getConnectorDefinitions	GET /connectordefinitions	Get the list of connector definitions from the library
AccessManagerApi.ConnectorDefinitionsApi	updateConnectorDefinition	PUT /connectordefinitions/{definitionID}	Update the connectorDefinition in the connectorDefinition library by connectorDefinition ID
AccessManagerApi.HealthApi	getHealth	GET /health	Get the system health
AccessManagerApi.IDPClustersApi	addAppmark	POST /idpclusters/{clusterID}/appmarks	Add an appmark to the specified IDP cluster
AccessManagerApi.IDPClustersApi	addConnectorInstance	POST /idpclusters/{clusterID}/connectorinstances	Add a connector instance to the specified IDP cluster
AccessManagerApi.IDPClustersApi	addServiceProvider	POST /idpclusters/{clusterID}/serviceproviders	Add a service provider specified IDP cluster
AccessManagerApi.IDPClustersApi	deleteAppmark	DELETE /idpclusters/{clusterID}/appmarks/{appmarkID}	Delete appmark
AccessManagerApi.IDPClustersApi	deleteConnectorInstanceById	DELETE /idpclusters/{clusterID}/connectorinstances/{instanceID}	Delete a connectorInstance by instanceID
AccessManagerApi.IDPClustersApi	deleteIDPSessions	DELETE /idpclusters/{clusterID}/sessions	Delete active IDP sessions
AccessManagerApi.IDPClustersApi	deleteManagedDevice	DELETE /idpclusters/{clusterID}/manageddevices/{deviceID}	Delete a managed device from the IDP cluster
AccessManagerApi.IDPClustersApi	getAppmarkById	GET /idpclusters/{clusterID}/appmarks/{appmarkID}	Get the specified Appmark from the IDP cluster
AccessManagerApi.IDPClustersApi	getAppmarks	GET /idpclusters/{clusterID}/appmarks	Get a list of Appmarks for the requested IDP cluster ID
AccessManagerApi.IDPClustersApi	getBranding	GET /idpclusters/{clusterID}/branding	Get the branding for the IDP cluster
AccessManagerApi.IDPClustersApi	getConnectorInstance	GET /idpclusters/{clusterID}/connectorinstances	Get a list of connector instances by idp cluster
AccessManagerApi.IDPClustersApi	getConnectorInstanceById	GET /idpclusters/{clusterID}/connectorinstances/{instanceID}	Get a Connector Instance by Id
AccessManagerApi.IDPClustersApi	getContractById	GET /idpclusters/{clusterID}/contracts/{contractID}	Get the specified contract from the IDP cluster
AccessManagerApi.IDPClustersApi	getContracts	GET /idpclusters/{clusterID}/contracts	Get a list of contracts for a specified IDP cluster
AccessManagerApi.IDPClustersApi	getIDPClusterAlertsById	GET /idpclusters/{clusterID}/alerts	Get the IDP cluster alerts
AccessManagerApi.IDPClustersApi	getIDPClusterById	GET /idpclusters/{clusterID}	Get the specified IDP cluster
AccessManagerApi.IDPClustersApi	getIDPClusterHealthById	GET /idpclusters/{clusterID}/health	Get the IDP cluster health
AccessManagerApi.IDPClustersApi	getIDPClusterStatisticsById	GET /idpclusters/{clusterID}/statistics	Get the IDP cluster statistics
AccessManagerApi.IDPClustersApi	getIDPClusters	GET /idpclusters	Get a list of IDP clusters
AccessManagerApi.IDPClustersApi	getIDPDeviceAlertsById	GET /idpclusters/{clusterID}/devices/{deviceID}/alerts	Get the IDP cluster alerts
AccessManagerApi.IDPClustersApi	getIDPDeviceById	GET /idpclusters/{clusterID}/devices/{deviceID}	Get the specified device from the IDP cluster
AccessManagerApi.IDPClustersApi	getIDPDeviceHealthById	GET /idpclusters/{clusterID}/devices/{deviceID}/health	Get the IDP cluster health
AccessManagerApi.IDPClustersApi	getIDPDeviceStatisticsById	GET /idpclusters/{clusterID}/devices/{deviceID}/statistics	Get the IDP device statistics
AccessManagerApi.IDPClustersApi	getIDPDevices	GET /idpclusters/{clusterID}/devices	Get a list of IDP devices for the requested IDP cluster ID
AccessManagerApi.IDPClustersApi	getIDPSessions	GET /idpclusters/{clusterID}/sessions	Get a list of IDP sessions for the requested IDP cluster ID
AccessManagerApi.IDPClustersApi	getIdentityProviderById	GET /idpclusters/{clusterID}/identityproviders/{providerID}	Get the IDP identity provider by ID
AccessManagerApi.IDPClustersApi	getIdentityProviders	GET /idpclusters/{clusterID}/identityproviders	Get a list of IDP cluster identity providers
AccessManagerApi.IDPClustersApi	getManagedDeviceById	GET /idpclusters/{clusterID}/manageddevices/{deviceID}	Get the IDP managed device by ID
AccessManagerApi.IDPClustersApi	getManagedDevices	GET /idpclusters/{clusterID}/manageddevices	Get a list of IDP cluster managed devices
AccessManagerApi.IDPClustersApi	getMethodById	GET /idpclusters/{clusterID}/methods/{methodID}	Get the specified method from the IDP cluster
AccessManagerApi.IDPClustersApi	getMethods	GET /idpclusters/{clusterID}/methods	Get a list of methods for a specified IDP cluster
AccessManagerApi.IDPClustersApi	getMobileAccess	GET /idpclusters/{clusterID}/mobileaccess	Get the MobileAccess object from the IDP cluster
AccessManagerApi.IDPClustersApi	getMobileUsers	GET /idpclusters/{clusterID}/mobileusers	Get a list of IDP cluster mobile users
AccessManagerApi.IDPClustersApi	getRoles	GET /idpclusters/{clusterID}/roles	Get a list of roles for a specified IDP cluster
AccessManagerApi.IDPClustersApi	getServiceProviderById	GET /idpclusters/{clusterID}/serviceproviders/{providerID}	Get the IDP service provider by ID
AccessManagerApi.IDPClustersApi	getServiceProviders	GET /idpclusters/{clusterID}/serviceproviders	Get a list of IDP cluster service providers
AccessManagerApi.IDPClustersApi	updateAppmark	PUT /idpclusters/{clusterID}/appmarks/{appmarkID}	Update an appmark in the IDP cluster
AccessManagerApi.IDPClustersApi	updateBranding	PUT /idpclusters/{clusterID}/branding	Update the branding for an IDP cluster by cluster ID
AccessManagerApi.IDPClustersApi	updateConnectorInstance	PUT /idpclusters/{clusterID}/connectorinstances/{instanceID}	Update a Connector Instance
AccessManagerApi.IDPClustersApi	updateIDPCluster	PUT /idpclusters/{clusterID}	Update an IDP cluster
AccessManagerApi.IDPClustersApi	updateIDPDevice	PUT /idpclusters/{clusterID}/devices/{deviceID}	Update an IDP cluster device
AccessManagerApi.IDPClustersApi	updateIdentityProviderMetadata	PUT /idpclusters/{clusterID}/identityproviders/{providerID}/metadata	Update the identity provider metadata by ID
AccessManagerApi.IDPClustersApi	updateMobileAccess	PUT /idpclusters/{clusterID}/mobileaccess	Update the MobileAccess object in the IDP cluster
AccessManagerApi.IDPClustersApi	updateServiceProviderMetadata	PUT /idpclusters/{clusterID}/serviceproviders/{providerID}/metadata	Update the service provider metadata by service provider ID
AccessManagerApi.IconsApi	addIcon	POST /icons	Add an icon to the icon library
AccessManagerApi.IconsApi	deleteIcon	DELETE /icons/{iconID}	Delete an icon from the icon library
AccessManagerApi.IconsApi	getIconById	GET /icons/{iconID}	Get an icon from the library by icon ID
AccessManagerApi.IconsApi	getIconByIdAndFormat	GET /icons/{iconID}.{iconFormat}	Get an icon image from the library by icon ID
AccessManagerApi.IconsApi	getIconMetadataById	GET /icons/{iconID}/metadata	Get an icon metadata only from the library by icon ID
AccessManagerApi.IconsApi	getIcons	GET /icons	Get the list of icons from the library
AccessManagerApi.IconsApi	updateIcon	PUT /icons/{iconID}	Update the icon in the image library by icon ID
AccessManagerApi.PoliciesApi	getPoliciesById	GET /policycontainers/{containerID}/policies	Get the policy container policies by ID
AccessManagerApi.PoliciesApi	getPolicyContainerById	GET /policycontainers/{containerID}	Get the policy container by ID
AccessManagerApi.PoliciesApi	getPolicyContainers	GET /policycontainers	Get a list of policy containers
AccessManagerApi.SecurityApi	getTrustedRootById	GET /security/trustedroots/{trustedRootID}	Get the trusted root certificate by ID. The ID of a trusted root is its display name.
AccessManagerApi.SecurityApi	updateCertificate	PUT /security/certificates/{certificateID}	Update the security certificate by certificate ID
AccessManagerApi.SecurityApi	updateTrustedRoot	PUT /security/trustedroots/{trustedRootID}	Update an existing trusted root certificate by ID.
AccessManagerApi.StatisticsApi	getStatistics	GET /statistics	Get the system statistics
AccessManagerApi.VersionApi	getVersion	GET /version	Get the version of this API

Documentation for Models

Documentation for Authorization

BasicAuth

Type: HTTP basic authentication

superagent

@everything-registry/sub-chunk-1092

1.0.0

8 years ago