AdminUsers.md

OrderCloud.AdminUsers

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

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

Create

User Create(user)

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.AdminUsers();

var user = new OrderCloud.User(); // User | 

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

Parameters

Name	Type	Description	Notes
user	User

Return type

User

Authorization

oauth2

HTTP request headers

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

Delete

Delete(userID)

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.AdminUsers();

var userID = "userID_example"; // String | ID of the user.

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

Parameters

Name	Type	Description	Notes
userID	String	ID of the user.

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

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

Get

User Get(userID)

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.AdminUsers();

var userID = "userID_example"; // String | ID of the user.

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

Parameters

Name	Type	Description	Notes
userID	String	ID of the user.

Return type

User

Authorization

oauth2

HTTP request headers

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

List

ListUser 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.AdminUsers();

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

ListUser

Authorization

oauth2

HTTP request headers

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

Patch

User Patch(userID, partialUser)

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.AdminUsers();

var userID = "userID_example"; // String | ID of the user.

var partialUser = new OrderCloud.User(); // User | 

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

Parameters

Name	Type	Description	Notes
userID	String	ID of the user.
partialUser	User

Return type

User

Authorization

oauth2

HTTP request headers

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

Save

User Save(userID, user)

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.AdminUsers();

var userID = "userID_example"; // String | ID of the user.

var user = new OrderCloud.User(); // User | 

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

Parameters

Name	Type	Description	Notes
userID	String	ID of the user.
user	User

Return type

User

Authorization

oauth2

HTTP request headers

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