1.0.0 • Published 6 years ago

seconize_de_risk_center_server_api_ v1.0.0

Weekly downloads
6
License
Seconize Propriet...
Repository
-
Last release
6 years ago

seconizede_risk_center_server_api

SeconizeDeRiskCenterServerApi - JavaScript client for seconize_de_risk_center_server_api This is the core API for Seconize DeRisk Center (DRC) This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: 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 seconize_de_risk_center_server_api_ --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var SeconizeDeRiskCenterServerApi_ = require('seconize_de_risk_center_server_api_');

var defaultClient = SeconizeDeRiskCenterServerApi_.ApiClient.instance;

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

var api = new SeconizeDeRiskCenterServerApi_.CompliancesApi()

var body = new SeconizeDeRiskCenterServerApi_.Compliance(); // {Compliance} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createCompliance(body, callback);

Documentation for API Endpoints

All URIs are relative to https://api.seconize.io/drc/v1

ClassMethodHTTP requestDescription
SeconizeDeRiskCenterServerApi_.CompliancesApicreateCompliancePOST /gcf/compliancesReturn the Compliance ID which was created
SeconizeDeRiskCenterServerApi_.CompliancesApideleteComplianceDELETE /gcf/compliances/{id}Delete the Compliance with the given id
SeconizeDeRiskCenterServerApi_.CompliancesApigetComplianceByIdGET /gcf/compliances/{id}Return the Compliance with the given id
SeconizeDeRiskCenterServerApi_.CompliancesApigetCompliancesGET /gcf/compliancesReturn Compliances according to the filter, sort and pagination parameters
SeconizeDeRiskCenterServerApi_.CompliancesApiupdateComplianceMaturityScorePUT /gcf/compliances/{id}Return the updated Compliance
SeconizeDeRiskCenterServerApi_.OrganizationsApigetOrganizationGET /assets/orgs/{id}Return the Organization with the given id
SeconizeDeRiskCenterServerApi_.OrganizationsApiupdateOrganizationPUT /assets/orgs/{id}Return the updated Org
SeconizeDeRiskCenterServerApi_.PoliciesApicreatePolicyPOST /gcf/policiesReturn the Policy ID which was created
SeconizeDeRiskCenterServerApi_.PoliciesApideletePolicyAssetTypeDELETE /gcf/policies/{id}/assettypes/{assettype}Delete the Policy with the given id
SeconizeDeRiskCenterServerApi_.PoliciesApigetPoliciesGET /gcf/policiesReturn Policies according to the filter, sort and pagination parameters
SeconizeDeRiskCenterServerApi_.PoliciesApigetPolicyAssetTypesGET /gcf/policies/{id}/assettypesReturn the Asset Types of the Policy with the given id
SeconizeDeRiskCenterServerApi_.PoliciesApiupdatePolicyActionPUT /gcf/policies/{id}/actionReturn the updated Policy
SeconizeDeRiskCenterServerApi_.PoliciesApiupdatePolicyAssetTypePUT /gcf/policies/{id}/assettypesReturn the updated Policy
SeconizeDeRiskCenterServerApi_.PoliciesApiupdatePolicyRASCIPUT /gcf/policies/{id}/rasciReturn the updated Policy
SeconizeDeRiskCenterServerApi_.PoliciesApiupdatePolicyScorePUT /gcf/policies/{id}/scoreReturn the updated Policy
SeconizeDeRiskCenterServerApi_.PoliciesApiupdatePolicyStatusPUT /gcf/policies/{id}/statusReturn the updated Policy
SeconizeDeRiskCenterServerApi_.PolicysApideletePolicyDELETE /gcf/policies/{id}Delete the Policy with the given id
SeconizeDeRiskCenterServerApi_.PolicysApigetPolicyByIdGET /gcf/policies/{id}Return the Policy with the given id
SeconizeDeRiskCenterServerApi_.ScansApicreateScanPOST /audit/scansReturn the Scan ID which was created
SeconizeDeRiskCenterServerApi_.ScansApideleteScanDELETE /audit/scans/{id}Delete the Scan with the given id
SeconizeDeRiskCenterServerApi_.ScansApigetScanByIdGET /audit/scans/{id}Return the Scan with the given id
SeconizeDeRiskCenterServerApi_.ScansApigetScansGET /audit/scansReturn Scans according to the filter, sort and pagination parameters
SeconizeDeRiskCenterServerApi_.ScansApiupdateScanPUT /audit/scans/{id}Return the updated Scan
SeconizeDeRiskCenterServerApi_.UsersApicreateBasicUserPOST /identity/usersReturn the user id which was created
SeconizeDeRiskCenterServerApi_.UsersApideleteUserDELETE /identity/users/{id}Delete the user with the given id
SeconizeDeRiskCenterServerApi_.UsersApideleteUserRBACDELETE /identity/users/{id}/rbac/{roleId}Delete the User with the given id
SeconizeDeRiskCenterServerApi_.UsersApigetUserByIdGET /identity/users/{id}Return the user with the given id
SeconizeDeRiskCenterServerApi_.UsersApigetUsersGET /identity/usersReturn users according to the filter, sort and pagination parameters
SeconizeDeRiskCenterServerApi_.UsersApiupdateUserRBACPUT /identity/users/{id}/rbacReturn the updated user

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication