uaa_api v0.0.1
uaa_api
UaaApi - JavaScript client for uaa_api uaa API documentation This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.1
- Package version: 0.0.1
- 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 uaa_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 uaa_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('uaa_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 UaaApi = require('uaa_api');
var api = new UaaApi.AccountresourceApi()
var key = "key_example"; // {String} key
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.activateAccountUsingGET(key, callback);
Documentation for API Endpoints
All URIs are relative to https://10.66.158.95:9080/uaa
Class | Method | HTTP request | Description |
---|---|---|---|
UaaApi.AccountresourceApi | activateAccountUsingGET | GET /api/activate | activateAccount |
UaaApi.AccountresourceApi | changePasswordUsingPOST | POST /api/account/change-password | changePassword |
UaaApi.AccountresourceApi | finishPasswordResetUsingPOST | POST /api/account/reset-password/finish | finishPasswordReset |
UaaApi.AccountresourceApi | getAccountUsingGET | GET /api/account | getAccount |
UaaApi.AccountresourceApi | isAuthenticatedUsingGET | GET /api/authenticate | isAuthenticated |
UaaApi.AccountresourceApi | registerAccountUsingPOST | POST /api/register | registerAccount |
UaaApi.AccountresourceApi | requestPasswordResetUsingPOST | POST /api/account/reset-password/init | requestPasswordReset |
UaaApi.AccountresourceApi | saveAccountUsingPOST | POST /api/account | saveAccount |
UaaApi.ProfileinforesourceApi | getActiveProfilesUsingGET | GET /api/profile-info | getActiveProfiles |
UaaApi.UserresourceApi | createUserUsingPOST | POST /api/users | createUser |
UaaApi.UserresourceApi | deleteUserUsingDELETE | DELETE /api/users/{login} | deleteUser |
UaaApi.UserresourceApi | getAllUsersUsingGET | GET /api/users | getAllUsers |
UaaApi.UserresourceApi | getAuthoritiesUsingGET | GET /api/users/authorities | getAuthorities |
UaaApi.UserresourceApi | getUserUsingGET | GET /api/users/{login} | getUser |
UaaApi.UserresourceApi | updateUserUsingPUT | PUT /api/users | updateUser |
Documentation for Models
Documentation for Authorization
All endpoints do not require authorization.
6 years ago