@teemill/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @teemill/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.podos.io/v1/enforcer

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EnforcerApi | assignRoleUser | PUT /roles/{role}/users/{user} | Assign users to a specific role in the given project EnforcerApi | auth | POST /auth | Authenticate a token EnforcerApi | createRole | POST /roles | Create role EnforcerApi | deleteRole | DELETE /roles/{role} | Delete role EnforcerApi | enforce | POST /enforce | Enforce access EnforcerApi | enforceMany | POST /enforceMany | Enforce access for multiple users EnforcerApi | getPermission | GET /permissions/{permission} | Get a permission EnforcerApi | getRole | GET /roles/{role} | Get a role EnforcerApi | getUser | GET /users/{user} | Get user EnforcerApi | healthz | GET /healthz | Healthz endpoint EnforcerApi | listAuditLogs | GET /audit/logs | List audit logs EnforcerApi | listPermissions | GET /permissions | List permissions EnforcerApi | listRoleUsers | GET /roles/{role}/users | List users for a specific role in the given project EnforcerApi | listRoles | GET /roles | List roles EnforcerApi | listUserAssignableRoles | GET /users/{user}/roles/assignable | List user assignable roles EnforcerApi | listUserPermissions | GET /users/{user}/permissions | List user permissions EnforcerApi | listUserRoles | GET /users/{user}/roles | List user roles EnforcerApi | listUsers | GET /users | List users EnforcerApi | unassignRoleUser | DELETE /roles/{role}/users/{user} | Remove a user from a specific role in the given project EnforcerApi | updateRole | PATCH /roles/{role} | Update role EnforcerAdminApi | assignAdminRoleUser | PUT /admin/roles/{role}/users/{user} | Assign users to a specific role in the given project EnforcerAdminApi | createAdminProject | POST /admin/projects | Create project EnforcerAdminApi | deleteAdminProject | DELETE /admin/projects/{project} | Delete project EnforcerAdminApi | deleteAdminProjectUser | DELETE /admin/projects/{project}/users/{user} | Delete project user EnforcerAdminApi | getAdminPermission | GET /admin/permissions/{permission} | Get a permission EnforcerAdminApi | getAdminProject | GET /admin/projects/{project} | Get project EnforcerAdminApi | getAdminRole | GET /admin/roles/{role} | Get a role EnforcerAdminApi | listAdminPermissions | GET /admin/permissions | List permissions EnforcerAdminApi | listAdminProjects | GET /admin/projects | List projects EnforcerAdminApi | listAdminRoles | GET /admin/roles | List roles EnforcerAdminApi | unassignAdminRoleUser | DELETE /admin/roles/{role}/users/{user} | Remove a user from a specific role in the given project EnforcerAdminApi | updateAdminPermission | PATCH /admin/permissions/{permission} | Update a permission EnforcerAdminApi | updateAdminProject | PATCH /admin/projects/{project} | Update project EnforcerAdminApi | updateAdminRole | PATCH /admin/roles/{role} | Update a role EnforcerAdminApi | updateAdminUser | PATCH /admin/users/{user} | Update user

Documentation For Models

• ApiError
• AuditLog
• AuditLogList
• AuthDenied
• AuthGranted
• AuthRequest
• CreateRoleRequest
• EnforceManyRequest
• EnforceRequest
• Healthz200Response
• ListRole
• OutcomeDenied
• OutcomeDeniedPermissions
• OutcomeDeniedPermissionsResolutions
• OutcomeDeniedPermissionsResolutionsRolesInner
• OutcomeGranted
• OutcomeGrantedPermissions
• OutcomeManyDenied
• OutcomeManyDeniedOutcomesInner
• OutcomeManyDeniedOutcomesInnerPermissions
• OutcomeManyGranted
• OutcomeManyGrantedOutcomesInner
• OutcomeResolution
• ParentRole
• Permission
• PermissionAuditLog
• PermissionList
• Project
• ProjectList
• Quota
• Role
• RoleAuditLog
• RoleList
• RoleUserList
• UpdateAdminPermissionRequest
• UpdateAdminProjectRequest
• UpdateAdminUserRequest
• UpdateRoleRequest
• User
• UserList
• UserPermissionList
• UserRole
• UserRoleList
• UserRolesInner

Documentation For Authorization

Authentication schemes defined for the API:

api-key

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

session-oauth

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A