@topoos/digitalidentity

@topoos/digitalidentity - JavaScript client for Digitalidentity API for Service Identity Provider This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
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 @topoos/digitalidentity --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 @topoos/digitalidentity 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 DigitalIdentity = require('@topoos/digitalidentity');

var defaultClient = DigitalIdentity.ApiClient.instance;
// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new DigitalIdentity.ApplicationsApi()
var id = "id_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.applicationsIdGet(id, callback);

Configuration

The developper will have to include the following parameters:

basePath:
- topoos Saas: https://api.topoos.com/digitalidentity/1
- onPremise: {url}/api/1/providers/{customerId}

Documentation for API Endpoints

All URIs are relative to https://api.topoos.com/digitalidentity/1.0.0

Class	Method	HTTP request
DigitalIdentity.ApplicationsApi	applicationsIdGet	GET /applications/{id}
DigitalIdentity.ApplicationsApi	applicationsIdPostlogoPost	POST /applications/{id}/postlogo
DigitalIdentity.ApplicationsApi	applicationsIdPut	PUT /applications/{id}
DigitalIdentity.ApplicationsApi	applicationsIdRefreshKeysPost	POST /applications/{id}/refresh_keys
DigitalIdentity.ApplicationsApi	applicationsPost	POST /applications
DigitalIdentity.OauthApiApi	oauthAccessTokenPost	POST /oauth/access_token
DigitalIdentity.OauthApiApi	oauthLoginPost	POST /oauth/login
DigitalIdentity.OauthApiApi	oauthLogoutDelete	DELETE /oauth/logout
DigitalIdentity.OauthApiApi	oauthRegisterPost	POST /oauth/register
DigitalIdentity.OauthApiApi	oauthRequestpasswordresetPost	POST /oauth/requestpasswordreset
DigitalIdentity.UsersApi	usersIdPut	PUT /users/{id}
DigitalIdentity.UsersApi	usersMeGet	GET /users/me
DigitalIdentity.WhoApi	whoGet	GET /who

Documentation for Models

Documentation for Authorization

default

Type: OAuth
Flow: implicit
Authorization URL: https://test.com
Scopes:
- elevated: Scope for privileged operations