rbac_api_jsclient

role_based_access_control

RoleBasedAccessControl - JavaScript client for role_based_access_control The API for Role Based Access Control. 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 role_based_access_control --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 RoleBasedAccessControl = require('role_based_access_control');

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

var api = new RoleBasedAccessControl.AccessApi()
var application = "application_example"; // {String} The application name to obtain access for the principal
var opts = {
  'username': "username_example", // {String} Unique username of the principal to obtain access for
  'pageSize': 10, // {Number} Parameter for selecting the amount of data in a page.
  'page': 1 // {Number} Parameter for selecting the page of data.
};
api.getPrincipalAccess(application, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost/r/insights/platform/rbac/v1

Class	Method	HTTP request	Description
RoleBasedAccessControl.AccessApi	getPrincipalAccess	GET /access/	Get the permitted access for a principal in the tenant
RoleBasedAccessControl.GroupApi	addPrincipalToGroup	POST /groups/{uuid}/principals/	Add a principal to a group in the tenant
RoleBasedAccessControl.GroupApi	createGroup	POST /groups/	Create a group in a tenant
RoleBasedAccessControl.GroupApi	deleteGroup	DELETE /groups/{uuid}/	Delete a group in the tenant
RoleBasedAccessControl.GroupApi	deletePrincipalFromGroup	DELETE /groups/{uuid}/principals/	Remove a principal from a group in the tenant
RoleBasedAccessControl.GroupApi	getGroup	GET /groups/{uuid}/	Get a group in the tenant
RoleBasedAccessControl.GroupApi	listGroups	GET /groups/	List the groups for a tenant
RoleBasedAccessControl.GroupApi	updateGroup	PUT /groups/{uuid}/	Udate a group in the tenant
RoleBasedAccessControl.PolicyApi	createPolicies	POST /policies/	Create a policy in a tenant
RoleBasedAccessControl.PolicyApi	deletePolicy	DELETE /policies/{uuid}/	Delete a policy in the tenant
RoleBasedAccessControl.PolicyApi	getPolicy	GET /policies/{uuid}/	Get a policy in the tenant
RoleBasedAccessControl.PolicyApi	listPolicies	GET /policies/	List the policies in the tenant
RoleBasedAccessControl.PolicyApi	updatePolicy	PUT /policies/{uuid}/	Update a policy in the tenant
RoleBasedAccessControl.PrincipalApi	getPrincipal	GET /principals/{username}/	Get a principal in the tenant
RoleBasedAccessControl.PrincipalApi	listPrincipals	GET /principals/	List the principals for a tenant
RoleBasedAccessControl.RoleApi	createRoles	POST /roles/	Create a roles for a tenant
RoleBasedAccessControl.RoleApi	deleteRole	DELETE /roles/{uuid}/	Delete a role in the tenant
RoleBasedAccessControl.RoleApi	getRole	GET /roles/{uuid}/	Get a role in the tenant
RoleBasedAccessControl.RoleApi	listRoles	GET /roles/	List the roles for a tenant
RoleBasedAccessControl.RoleApi	updateRole	PUT /roles/{uuid}/	Update a Role in the tenant
RoleBasedAccessControl.StatusApi	getStatus	GET /status/	Obtain server status

Documentation for Models

• RoleBasedAccessControl.Access
• RoleBasedAccessControl.AccessPagination
• RoleBasedAccessControl.Error
• RoleBasedAccessControl.Group
• RoleBasedAccessControl.GroupOut
• RoleBasedAccessControl.GroupPagination
• RoleBasedAccessControl.GroupPrincipalIn
• RoleBasedAccessControl.GroupWithPrincipals
• RoleBasedAccessControl.ListPagination
• RoleBasedAccessControl.PaginationLinks
• RoleBasedAccessControl.PaginationMeta
• RoleBasedAccessControl.Policy
• RoleBasedAccessControl.PolicyExtended
• RoleBasedAccessControl.PolicyIn
• RoleBasedAccessControl.PolicyOut
• RoleBasedAccessControl.PolicyPagination
• RoleBasedAccessControl.Principal
• RoleBasedAccessControl.PrincipalIn
• RoleBasedAccessControl.PrincipalOut
• RoleBasedAccessControl.PrincipalPagination
• RoleBasedAccessControl.ResourceDefinition
• RoleBasedAccessControl.ResourceDefinitionFilter
• RoleBasedAccessControl.Role
• RoleBasedAccessControl.RoleIn
• RoleBasedAccessControl.RoleOut
• RoleBasedAccessControl.RolePagination
• RoleBasedAccessControl.RoleWithAccess
• RoleBasedAccessControl.Status
• RoleBasedAccessControl.UUID

Documentation for Authorization

basic_auth

• Type: HTTP basic authentication