DocdokuPlmApi.AuthApi

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

getProvider

OAuthProviderPublicDTO getProvider(id)

Get OAuth provider details

Example

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);

Parameters

Name Type Description Notes
id Number Provider id

Return type

OAuthProviderPublicDTO

Authorization

No authorization required

HTTP request headers

getProviders

[OAuthProviderPublicDTO] getProviders()

Get registered OAuth providers

Example

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);

Parameters

This endpoint does not need any parameter.

Return type

[OAuthProviderPublicDTO]

Authorization

No authorization required

HTTP request headers

login

AccountDTO login(body)

Try to authenticate with credentials

Example

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);

Parameters

Name Type Description Notes
body LoginRequestDTO Login request

Return type

AccountDTO

Authorization

No authorization required

HTTP request headers

logout

logout()

Log out connected user

Example

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);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

oAuthLogin

AccountDTO oAuthLogin(body)

Try to authenticate with OAuth

Example

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);

Parameters

Name Type Description Notes
body OAuthLoginRequestDTO OAuth login request

Return type

AccountDTO

Authorization

No authorization required

HTTP request headers

sendPasswordRecover

sendPasswordRecover(body)

Recover account password

Example

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);

Parameters

Name Type Description Notes
body PasswordRecoverDTO Password recovery process

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

sendPasswordRecovery

sendPasswordRecovery(body)

Send password recovery request

Example

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);

Parameters

Name Type Description Notes
body PasswordRecoveryRequestDTO Password recovery request

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers