❤
npm
Sign UpSign In

cipherbase_api_client

1.0.2 • Public • Published

cipherbase_api_client

CipherbaseApiClient - JavaScript client for cipherbase_api_client API client for Cipherbase.io - a set of APIs to enable you to segregate, encrypt and pseudonymize sensitive PII This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.2
  • Package version: 1.0.2
  • 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 cipherbase_api_client --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your cipherbase_api_client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cipherbase_api_client') in javascript files from the directory you ran the last command above from.

git

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

    npm install YOUR_USERNAME/cipherbase_api_client --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, that's to say your javascript file where you actually use this library):

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 CipherbaseApiClient = require('cipherbase_api_client');

var defaultClient = CipherbaseApiClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new CipherbaseApiClient.AuditApi()

var opts = { 
  'pageSize': 56, // {Number} 
  'pageToken': 56, // {Number} 
  'roleId': "roleId_example", // {String} 
  'userId': "userId_example", // {String} 
  'piiId': "piiId_example", // {String} 
  'dataId': "dataId_example", // {String} 
  'action': "action_example", // {String} 
  'before': new Date("2013-10-20T19:20:30+01:00"), // {Date} 
  'after': new Date("2013-10-20T19:20:30+01:00") // {Date} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAudit(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhosthttps://api.cipherbase.io

Class Method HTTP request Description
CipherbaseApiClient.AuditApi listAudit GET /v1/audit List and query audit logs - access restricted to admin role
CipherbaseApiClient.DataApi createBatchData POST /v1/pii/{piiId}/data/batch Create a batch of data records
CipherbaseApiClient.DataApi createData POST /v1/pii/{piiId}/data Create a new data record
CipherbaseApiClient.DataApi deleteData DELETE /v1/pii/{piiId}/data/{id} Delete a single data record
CipherbaseApiClient.DataApi getData GET /v1/pii/{piiId}/data/{id} Get a single data record
CipherbaseApiClient.DataApi listData GET /v1/pii/{piiId}/data Get a list of data records
CipherbaseApiClient.DataApi updateData PUT /v1/pii/{piiId}/data/{id} Update a single data record
CipherbaseApiClient.HealthApi health GET /_ah/health
CipherbaseApiClient.PiiRepositoryApi createPii POST /v1/pii Create a new PII Repository
CipherbaseApiClient.PiiRepositoryApi deletePii DELETE /v1/pii/{id} Delete a PII Repository
CipherbaseApiClient.PiiRepositoryApi getPii GET /v1/pii/{id} Get a single PII Repository
CipherbaseApiClient.PiiRepositoryApi listPii GET /v1/pii List PII Repositories
CipherbaseApiClient.PiiRepositoryApi updatePii PUT /v1/pii/{id} Update details of a PII Repository
CipherbaseApiClient.PolicyApi getPolicy GET /v1/policy/{id} Get a policy - access restricted to admin role
CipherbaseApiClient.PolicyApi listPolicies GET /v1/policy List policies - access restricted to admin role
CipherbaseApiClient.PolicyApi updatePolicy PUT /v1/policy/{id} Update details of a policy - access restricted to admin role
CipherbaseApiClient.UserApi createUser POST /v1/user Create a new user for an organization - access restricted to admin role
CipherbaseApiClient.UserApi getProfile GET /v1/profile Get user profile
CipherbaseApiClient.UserApi getUser GET /v1/user/{id} Get the user profile for a particular user - access restricted to admin role
CipherbaseApiClient.UserApi listRoles GET /v1/role List role details for your organization - access restricted to admin role
CipherbaseApiClient.UserApi listUsers GET /v1/user List user details for your organization - access restricted to admin role
CipherbaseApiClient.UserApi login POST /v1/login Authenticate a user
CipherbaseApiClient.UserApi signup POST /v1/signup Signup a new user

Documentation for Models

Documentation for Authorization

bearerAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Readme

Keywords

none

Package Sidebar

Install

npm i cipherbase_api_client

Weekly Downloads

3

Version

1.0.2

License

Unlicense

Unpacked Size

439 kB

Total Files

149

Last publish

Collaborators

  • schumanzhang
Try on RunKit
Report malware