Skip to content

Latest commit

 

History

History
319 lines (200 loc) · 8.79 KB

ImpersonationConfigs.md

File metadata and controls

319 lines (200 loc) · 8.79 KB
Raw

OrderCloud.ImpersonationConfigs

All URIs are relative to https://api.ordercloud.io/v1

Method HTTP request Description
Create POST /impersonationconfig
Delete DELETE /impersonationconfig/{impersonationConfigID}
Get GET /impersonationconfig/{impersonationConfigID}
List GET /impersonationconfig
Patch PATCH /impersonationconfig/{impersonationConfigID}
Save PUT /impersonationconfig/{impersonationConfigID}

Create

ImpersonationConfig Create(impersonationConfig)

Example

var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;

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

var apiInstance = new OrderCloud.ImpersonationConfigs();

var impersonationConfig = new OrderCloud.ImpersonationConfig(); // ImpersonationConfig | 

apiInstance.Create(impersonationConfig).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
impersonationConfig ImpersonationConfig

Return type

ImpersonationConfig

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/plain; charset=utf-8
  • Accept: application/json

Delete

Delete(impersonationConfigID)

Example

var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;

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

var apiInstance = new OrderCloud.ImpersonationConfigs();

var impersonationConfigID = "impersonationConfigID_example"; // String | ID of the impersonation config.

apiInstance.Delete(impersonationConfigID).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
impersonationConfigID String ID of the impersonation config.

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/plain; charset=utf-8
  • Accept: application/json

Get

ImpersonationConfig Get(impersonationConfigID)

Example

var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;

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

var apiInstance = new OrderCloud.ImpersonationConfigs();

var impersonationConfigID = "impersonationConfigID_example"; // String | ID of the impersonation config.

apiInstance.Get(impersonationConfigID).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
impersonationConfigID String ID of the impersonation config.

Return type

ImpersonationConfig

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/plain; charset=utf-8
  • Accept: application/json

List

ListImpersonationConfig List(opts)

Example

var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;

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

var apiInstance = new OrderCloud.ImpersonationConfigs();

var opts = { 
  'search': "search_example", // String | Word or phrase to search for.
  'searchOn': "searchOn_example", // String | Comma-delimited list of fields to search on.
  'sortBy': "sortBy_example", // String | Comma-delimited list of fields to sort by.
  'page': 56, // Number | Page of results to return. Default: 1
  'pageSize': 56, // Number | Number of results to return per page. Default: 20, max: 100.
  'filters': {key: "filters_example"} // {String: String} | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
};
apiInstance.List(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
search String Word or phrase to search for. [optional]
searchOn String Comma-delimited list of fields to search on. [optional]
sortBy String Comma-delimited list of fields to sort by. [optional]
page Number Page of results to return. Default: 1 [optional]
pageSize Number Number of results to return per page. Default: 20, max: 100. [optional]
filters {String: String} Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' [optional]

Return type

ListImpersonationConfig

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/plain; charset=utf-8
  • Accept: application/json

Patch

ImpersonationConfig Patch(impersonationConfigID, partialImpersonationConfig)

Example

var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;

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

var apiInstance = new OrderCloud.ImpersonationConfigs();

var impersonationConfigID = "impersonationConfigID_example"; // String | ID of the impersonation config.

var partialImpersonationConfig = new OrderCloud.ImpersonationConfig(); // ImpersonationConfig | 

apiInstance.Patch(impersonationConfigID, partialImpersonationConfig).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
impersonationConfigID String ID of the impersonation config.
partialImpersonationConfig ImpersonationConfig

Return type

ImpersonationConfig

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/plain; charset=utf-8
  • Accept: application/json

Save

ImpersonationConfig Save(impersonationConfigID, impersonationConfig)

Example

var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;

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

var apiInstance = new OrderCloud.ImpersonationConfigs();

var impersonationConfigID = "impersonationConfigID_example"; // String | ID of the impersonation config.

var impersonationConfig = new OrderCloud.ImpersonationConfig(); // ImpersonationConfig | 

apiInstance.Save(impersonationConfigID, impersonationConfig).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
impersonationConfigID String ID of the impersonation config.
impersonationConfig ImpersonationConfig

Return type

ImpersonationConfig

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/plain; charset=utf-8
  • Accept: application/json