Skip to content

Latest commit

 

History

History
1338 lines (954 loc) · 34.1 KB

AuthApi.md

File metadata and controls

1338 lines (954 loc) · 34.1 KB

DnlApi.AuthApi

All URIs are relative to https://198.100.149.164:8000/v1

Method HTTP request Description
authAsAgentPost POST /auth/as_agent
authAsClientPost POST /auth/as_client
authCheckPasswordPost POST /auth/check-password
authCheckTokenPost POST /auth/check-token
authPost POST /auth
authResetEmailPost POST /auth/reset_email
authResetTokenGet GET /auth/reset/{token}
registrationAllDelete DELETE /registration/all
registrationCreatePost POST /registration/create
registrationIdApprovePatch PATCH /registration/{id}/approve
registrationIdDelete DELETE /registration/{id}
registrationIdGet GET /registration/{id}
registrationIdPatch PATCH /registration/{id}
registrationListGet GET /registration/list
userAllDelete DELETE /user/all
userAllPatch PATCH /user/all
userCreatePost POST /user/create
userGet GET /user
userListGet GET /user/list
userUserIdDelete DELETE /user/{user_id}
userUserIdGet GET /user/{user_id}
userUserIdPatch PATCH /user/{user_id}

authAsAgentPost

AuthToken authAsAgentPost(opts)

Authenticate as agent

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'body': new DnlApi.AuthAsAgent() // AuthAsAgent | Agent reference id
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.authAsAgentPost(opts, callback);

Parameters

Name Type Description Notes
body AuthAsAgent Agent reference id [optional]

Return type

AuthToken

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

authAsClientPost

AuthToken authAsClientPost(opts)

Authenticate as client

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'body': new DnlApi.AuthAsClient() // AuthAsClient | Client reference id
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.authAsClientPost(opts, callback);

Parameters

Name Type Description Notes
body AuthAsClient Client reference id [optional]

Return type

AuthToken

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

authCheckPasswordPost

Success authCheckPasswordPost(opts)

Checks current user password

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'body': new DnlApi.PasswordCheck() // PasswordCheck | User password
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.authCheckPasswordPost(opts, callback);

Parameters

Name Type Description Notes
body PasswordCheck User password [optional]

Return type

Success

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

authCheckTokenPost

AuthToken authCheckTokenPost()

Checks and refreshes token

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.authCheckTokenPost(callback);

Parameters

This endpoint does not need any parameter.

Return type

AuthToken

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

authPost

AuthToken authPost(opts)

Authenticates user

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: api_auth
var api_auth = defaultClient.authentications['api_auth'];
api_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'body': new DnlApi.Credentials() // Credentials | User credentials
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.authPost(opts, callback);

Parameters

Name Type Description Notes
body Credentials User credentials [optional]

Return type

AuthToken

Authorization

api_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

authResetEmailPost

Success authResetEmailPost(opts)

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'body': new DnlApi.UserResetPasswordLetter() // UserResetPasswordLetter | Email to check
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.authResetEmailPost(opts, callback);

Parameters

Name Type Description Notes
body UserResetPasswordLetter Email to check [optional]

Return type

Success

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

authResetTokenGet

Success authResetTokenGet(token)

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var token = "token_example"; // String | Token from email


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.authResetTokenGet(token, callback);

Parameters

Name Type Description Notes
token String Token from email

Return type

Success

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

registrationAllDelete

InlineResponse2002 registrationAllDelete(opts)

Deletes multiple found signup

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'city': "city_example", // String | 
  'clientName': "clientName_example", // String | 
  'company': "company_example", // String | 
  'idIn': "idIn_example", // String | 
  'mainEmail': "mainEmail_example", // String | 
  'modifiedOnGt': "modifiedOnGt_example", // String | 
  'modifiedOnLt': "modifiedOnLt_example", // String | 
  'phone': "phone_example", // String | 
  'referral': "referral_example", // String | 
  'signedUpOnGt': "signedUpOnGt_example", // String | 
  'signedUpOnLt': "signedUpOnLt_example", // String | 
  'status': "status_example", // String | 
  'username': "username_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.registrationAllDelete(opts, callback);

Parameters

Name Type Description Notes
city String [optional]
clientName String [optional]
company String [optional]
idIn String [optional]
mainEmail String [optional]
modifiedOnGt String [optional]
modifiedOnLt String [optional]
phone String [optional]
referral String [optional]
signedUpOnGt String [optional]
signedUpOnLt String [optional]
status String [optional]
username String [optional]

Return type

InlineResponse2002

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

registrationCreatePost

ObjectCreated registrationCreatePost(opts)

Creates new signup

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: api_auth
var api_auth = defaultClient.authentications['api_auth'];
api_auth.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'body': new DnlApi.Signup() // Signup | Signup to create
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.registrationCreatePost(opts, callback);

Parameters

Name Type Description Notes
body Signup Signup to create [optional]

Return type

ObjectCreated

Authorization

api_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

registrationIdApprovePatch

InlineResponse2004 registrationIdApprovePatch(id, opts)

Modifies signup approval

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var id = 789; // Number | Signup approval id to get info about

var opts = { 
  'body': new DnlApi.SignupApprove() // SignupApprove | Signup approval to modify
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.registrationIdApprovePatch(id, opts, callback);

Parameters

Name Type Description Notes
id Number Signup approval id to get info about
body SignupApprove Signup approval to modify [optional]

Return type

InlineResponse2004

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

registrationIdDelete

Success registrationIdDelete(id)

Deletes signup

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var id = 789; // Number | Signup id to get info about


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.registrationIdDelete(id, callback);

Parameters

Name Type Description Notes
id Number Signup id to get info about

Return type

Success

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

registrationIdGet

InlineResponse2004 registrationIdGet(id)

Gets signup

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var id = 789; // Number | Signup id to get info about


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.registrationIdGet(id, callback);

Parameters

Name Type Description Notes
id Number Signup id to get info about

Return type

InlineResponse2004

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

registrationIdPatch

InlineResponse2004 registrationIdPatch(id, opts)

Modifies signup

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var id = 789; // Number | Signup id to get info about

var opts = { 
  'body': new DnlApi.SignupModify() // SignupModify | Signup to modify
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.registrationIdPatch(id, opts, callback);

Parameters

Name Type Description Notes
id Number Signup id to get info about
body SignupModify Signup to modify [optional]

Return type

InlineResponse2004

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

registrationListGet

InlineResponse2005 registrationListGet(opts)

Gets signups

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'page': 56, // Number | 
  'perPage': 56, // Number | 
  'orderBy': "orderBy_example", // String | 
  'orderDir': "orderDir_example", // String | 
  'city': "city_example", // String | 
  'clientName': "clientName_example", // String | 
  'company': "company_example", // String | 
  'mainEmail': "mainEmail_example", // String | 
  'phone': "phone_example", // String | 
  'referral': "referral_example", // String | 
  'status': "status_example", // String | 
  'username': "username_example", // String | 
  'idIn': "idIn_example", // String | 
  'modifiedOnGt': "modifiedOnGt_example", // String | 
  'modifiedOnLt': "modifiedOnLt_example", // String | 
  'signedUpOnGt': "signedUpOnGt_example", // String | 
  'signedUpOnLt': "signedUpOnLt_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.registrationListGet(opts, callback);

Parameters

Name Type Description Notes
page Number [optional]
perPage Number [optional]
orderBy String [optional]
orderDir String [optional]
city String [optional]
clientName String [optional]
company String [optional]
mainEmail String [optional]
phone String [optional]
referral String [optional]
status String [optional]
username String [optional]
idIn String [optional]
modifiedOnGt String [optional]
modifiedOnLt String [optional]
signedUpOnGt String [optional]
signedUpOnLt String [optional]

Return type

InlineResponse2005

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

userAllDelete

InlineResponse2002 userAllDelete(opts)

Deletes multiple found user

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'active': true, // Boolean | 
  'createTimeGt': "createTimeGt_example", // String | 
  'createTimeLt': "createTimeLt_example", // String | 
  'email': "email_example", // String | 
  'isOnline': 56, // Number | 
  'lastLoginTimeGt': "lastLoginTimeGt_example", // String | 
  'lastLoginTimeLt': "lastLoginTimeLt_example", // String | 
  'loginIp': "loginIp_example", // String | 
  'name': "name_example", // String | 
  'roleId': 56, // Number | 
  'userId': 56, // Number | 
  'userIdIn': "userIdIn_example", // String | 
  'userType': "userType_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userAllDelete(opts, callback);

Parameters

Name Type Description Notes
active Boolean [optional]
createTimeGt String [optional]
createTimeLt String [optional]
email String [optional]
isOnline Number [optional]
lastLoginTimeGt String [optional]
lastLoginTimeLt String [optional]
loginIp String [optional]
name String [optional]
roleId Number [optional]
userId Number [optional]
userIdIn String [optional]
userType String [optional]

Return type

InlineResponse2002

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

userAllPatch

InlineResponse2002 userAllPatch(opts)

Modifies multiple found user

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'body': new DnlApi.UserActivate(), // UserActivate | User to modify
  'active': true, // Boolean | 
  'createTimeGt': "createTimeGt_example", // String | 
  'createTimeLt': "createTimeLt_example", // String | 
  'email': "email_example", // String | 
  'isOnline': 56, // Number | 
  'lastLoginTimeGt': "lastLoginTimeGt_example", // String | 
  'lastLoginTimeLt': "lastLoginTimeLt_example", // String | 
  'loginIp': "loginIp_example", // String | 
  'name': "name_example", // String | 
  'roleId': 56, // Number | 
  'userId': 56, // Number | 
  'userIdIn': "userIdIn_example", // String | 
  'userType': "userType_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userAllPatch(opts, callback);

Parameters

Name Type Description Notes
body UserActivate User to modify [optional]
active Boolean [optional]
createTimeGt String [optional]
createTimeLt String [optional]
email String [optional]
isOnline Number [optional]
lastLoginTimeGt String [optional]
lastLoginTimeLt String [optional]
loginIp String [optional]
name String [optional]
roleId Number [optional]
userId Number [optional]
userIdIn String [optional]
userType String [optional]

Return type

InlineResponse2002

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

userCreatePost

ObjectCreated userCreatePost(opts)

Creates new user

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'body': new DnlApi.User() // User | User to create
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userCreatePost(opts, callback);

Parameters

Name Type Description Notes
body User User to create [optional]

Return type

ObjectCreated

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

userGet

InlineResponse200 userGet()

Gets userinfo

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userGet(callback);

Parameters

This endpoint does not need any parameter.

Return type

InlineResponse200

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

userListGet

InlineResponse2003 userListGet(opts)

Gets users

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var opts = { 
  'page': 56, // Number | 
  'perPage': 56, // Number | 
  'orderBy': "orderBy_example", // String | 
  'orderDir': "orderDir_example", // String | 
  'active': true, // Boolean | 
  'isOnline': 56, // Number | 
  'name': "name_example", // String | 
  'roleId': 56, // Number | 
  'userType': "userType_example", // String | 
  'createTimeGt': "createTimeGt_example", // String | 
  'createTimeLt': "createTimeLt_example", // String | 
  'lastLoginTimeGt': "lastLoginTimeGt_example", // String | 
  'lastLoginTimeIsnull': true, // Boolean | 
  'lastLoginTimeLt': "lastLoginTimeLt_example", // String | 
  'userIdIn': "userIdIn_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userListGet(opts, callback);

Parameters

Name Type Description Notes
page Number [optional]
perPage Number [optional]
orderBy String [optional]
orderDir String [optional]
active Boolean [optional]
isOnline Number [optional]
name String [optional]
roleId Number [optional]
userType String [optional]
createTimeGt String [optional]
createTimeLt String [optional]
lastLoginTimeGt String [optional]
lastLoginTimeIsnull Boolean [optional]
lastLoginTimeLt String [optional]
userIdIn String [optional]

Return type

InlineResponse2003

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

userUserIdDelete

Success userUserIdDelete(userId)

Deletes user

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var userId = 789; // Number | User id to get info about


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userUserIdDelete(userId, callback);

Parameters

Name Type Description Notes
userId Number User id to get info about

Return type

Success

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

userUserIdGet

InlineResponse2001 userUserIdGet(userId)

Gets user

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var userId = 789; // Number | User id to get info about


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userUserIdGet(userId, callback);

Parameters

Name Type Description Notes
userId Number User id to get info about

Return type

InlineResponse2001

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

userUserIdPatch

InlineResponse2001 userUserIdPatch(userId, opts)

Modifies user

Example

var DnlApi = require('dnl_api');
var defaultClient = DnlApi.ApiClient.instance;

// Configure API key authorization: auth_token
var auth_token = defaultClient.authentications['auth_token'];
auth_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//auth_token.apiKeyPrefix = 'Token';

var apiInstance = new DnlApi.AuthApi();

var userId = 789; // Number | User id to get info about

var opts = { 
  'body': new DnlApi.User() // User | User to modify
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.userUserIdPatch(userId, opts, callback);

Parameters

Name Type Description Notes
userId Number User id to get info about
body User User to modify [optional]

Return type

InlineResponse2001

Authorization

auth_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json