All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
getProvider | GET /auth/providers/{id} | Get OAuth provider details |
getProviders | GET /auth/providers | Get registered OAuth providers |
login | POST /auth/login | Try to authenticate with credentials |
logout | GET /auth/logout | Log out connected user |
oAuthLogin | POST /auth/oauth | Try to authenticate with OAuth |
sendPasswordRecover | POST /auth/recover | Recover account password |
sendPasswordRecovery | POST /auth/recovery | Send password recovery request |
OAuthProviderPublicDTO getProvider(id)
Get OAuth provider details
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.AuthApi();
var id = 56; // Number | Provider id
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getProvider(id, callback);
Name | Type | Description | Notes |
---|---|---|---|
id | Number | Provider id |
No authorization required
[OAuthProviderPublicDTO] getProviders()
Get registered OAuth providers
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.AuthApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getProviders(callback);
This endpoint does not need any parameter.
No authorization required
AccountDTO login(body)
Try to authenticate with credentials
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.AuthApi();
var body = new DocdokuPlmApi.LoginRequestDTO(); // LoginRequestDTO | Login request
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.login(body, callback);
Name | Type | Description | Notes |
---|---|---|---|
body | LoginRequestDTO | Login request |
No authorization required
logout()
Log out connected user
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.AuthApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.logout(callback);
This endpoint does not need any parameter.
null (empty response body)
No authorization required
AccountDTO oAuthLogin(body)
Try to authenticate with OAuth
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.AuthApi();
var body = new DocdokuPlmApi.OAuthLoginRequestDTO(); // OAuthLoginRequestDTO | OAuth login request
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.oAuthLogin(body, callback);
Name | Type | Description | Notes |
---|---|---|---|
body | OAuthLoginRequestDTO | OAuth login request |
No authorization required
sendPasswordRecover(body)
Recover account password
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.AuthApi();
var body = new DocdokuPlmApi.PasswordRecoverDTO(); // PasswordRecoverDTO | Password recovery process
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.sendPasswordRecover(body, callback);
Name | Type | Description | Notes |
---|---|---|---|
body | PasswordRecoverDTO | Password recovery process |
null (empty response body)
No authorization required
sendPasswordRecovery(body)
Send password recovery request
var DocdokuPlmApi = require('docdoku-plm-api');
var apiInstance = new DocdokuPlmApi.AuthApi();
var body = new DocdokuPlmApi.PasswordRecoveryRequestDTO(); // PasswordRecoveryRequestDTO | Password recovery request
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.sendPasswordRecovery(body, callback);
Name | Type | Description | Notes |
---|---|---|---|
body | PasswordRecoveryRequestDTO | Password recovery request |
null (empty response body)
No authorization required