1.0.0 • Published 5 years ago

kibo-auth-sdk v1.0.0

Weekly downloads
1
License
Unlicense
Repository
github
Last release
5 years ago

kibo-auth-sdk

KiboAppDevService - JavaScript client for kibo_app_dev_service No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

  • Package version: 1.0.0
  • Build package: org.openapitools.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 kibo-auth-sdk --save

Finally, you need to build the module:

npm run build
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

To use the link you just defined in your project, switch to the directory you want to use your kibo_app_dev_service from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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 Auth = require('kibo-sdk-auth');

var authApiClient = Auth.ApiClient.instance;

authApiClient.basePath = "[base path]";

var mozuAppDevContractsOauthAuthRequest = new Auth.MozuAppDevContractsOauthAuthRequest()
mozuAppDevContractsOauthAuthRequest.client_id = "[client_id]";
mozuAppDevContractsOauthAuthRequest.client_secret = "[client_secret]";


let apiInstance = new Auth.AppAuthTicketsApi(authApiClient);
let opts = {
  'xVolTenant': null, // Number | 
  'xVolSite': null, // Number | 
  'appAuthInfo': mozuAppDevContractsOauthAuthRequest // MozuAppDevContractsOauthAuthRequest | 
};
apiInstance.oauthAuthenticateApp(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log(data);
  }
});

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
KiboAppDevService.AppAuthTicketsApioauthAuthenticateAppPOST /platform/applications/authtickets/oauth

Documentation for Models

Documentation for Authorization

x-vol-app-claims

  • Type: API key
  • API key parameter name: x-vol-app-claims
  • Location: HTTP header

x-vol-user-claims

  • Type: API key
  • API key parameter name: x-vol-user-claims
  • Location: HTTP header