@topoos/acl

acl

Acl - JavaScript client for acl ACL OpenApi definition 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 acl --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 acl 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 Acl = require('acl');

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

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
Acl.RoleApi	rolesGet	GET /roles	Retrieves provider roles
Acl.RoleApi	rolesRoleIdDelete	DELETE /roles/{roleId}	Deletes desired role
Acl.RoleApi	rolesRoleIdGet	GET /roles/{roleId}	Retrieves desired role
Acl.RoleApi	rolesRoleIdPut	PUT /roles/{roleId}	Updates or inserts given role for the provider. If provider doesn't exist, creates it.
Acl.UserApi	usersPost	POST /users	Creates a new user for the provider. If provider doesn't exist, creates it.
Acl.UserRoleApi	usersRolesGet	GET /users/roles	Get all provider's users, with their roles
Acl.UserRoleApi	usersUserIdRolesGet	GET /users/{userId}/roles	Get user's roles
Acl.UserRoleApi	usersUserIdRolesPut	PUT /users/{userId}/roles	Overrides user's roles

Documentation for Models

• Acl.ErrorResponse
• Acl.ErrorResponseError
• Acl.InlineObject
• Acl.InlineObject1
• Acl.InlineResponse200
• Acl.InlineResponse2001
• Acl.InlineResponse2001Data
• Acl.InlineResponse2001DataItems
• Acl.InlineResponse2002
• Acl.InlineResponse200Data
• Acl.Role

Documentation for Authorization

default

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