security_api v1.0.0
security_api
SecurityApi - JavaScript client for security_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.0
- Build package: io.swagger.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 security_api --save
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
Finally, switch to the directory you want to use your security_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('security_api')
in javascript files from the directory you ran the last
command above from.
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, that's to say your javascript file where you actually
use this library):
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 SecurityApi = require('security_api');
var defaultClient = SecurityApi.ApiClient.instance;
// Configure API key authorization: HttpBearerAuth
var HttpBearerAuth = defaultClient.authentications['HttpBearerAuth'];
HttpBearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//HttpBearerAuth.apiKeyPrefix['Authorization'] = "Token"
var api = new SecurityApi.DefaultApi()
var token = "token_example"; // {String}
var opts = {
'body': new SecurityApi.Body3() // {Body3}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.authActivateUserPost(token, opts, callback);
Documentation for API Endpoints
All URIs are relative to https://example.com/security
Class | Method | HTTP request | Description |
---|---|---|---|
SecurityApi.DefaultApi | authActivateUserPost | POST /auth/activate-user | Activate User |
SecurityApi.DefaultApi | authLoginPost | POST /auth/login | Автоирзация пользователя |
SecurityApi.DefaultApi | authLogoutPost | POST /auth/logout | Деавтоирзация пользователя |
SecurityApi.DefaultApi | authRequestPasswordResetPost | POST /auth/request-password-reset | Request Password Reset |
SecurityApi.DefaultApi | authResetPasswordPost | POST /auth/reset-password | Reset Password |
Documentation for Models
- SecurityApi.Body
- SecurityApi.Body1
- SecurityApi.Body2
- SecurityApi.Body3
- SecurityApi.UserCommon
- SecurityApi.AuthorizedUser
Documentation for Authorization
HttpBearerAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
4 years ago