Skip to content

Latest commit

 

History

History
114 lines (85 loc) · 4.11 KB

instanceOrgs.md

File metadata and controls

114 lines (85 loc) · 4.11 KB

Instance Orgs Actions

Details on the various actions that can be performed on the Instance Orgs resource, including the expected parameters and the potential responses.

Contents

Get

Returns the organizations associated with the current instance

var params = {
  instanceId: myInstanceId
};

// with callbacks
client.instanceOrgs.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.instanceOrgs.get(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgs.*, or instanceOrgs.get.

Available Parameters

Name Type Required Description Default Example
instanceId string Y ID associated with the instance 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated name name
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name name
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*org
summaryInclude string N Comma-separated list of summary fields to include in org summary payloadCount
query Advanced Instance Organization Query N Organization filter JSON object which overrides all other filter params. Advanced Instance Organization Query Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Instance Organizations A collection of organizations

Error Responses

Code Type Description
400 Error Error if malformed request

Post

Create a new organization

var params = {
  instanceId: myInstanceId
};

// with callbacks
client.instanceOrgs.post(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.instanceOrgs.post(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceOrgs.*, or instanceOrgs.post.

Available Parameters

Name Type Required Description Default Example
instanceId string Y ID associated with the instance 575ec8687ae143cd83dc4a97
summaryInclude string N Comma-separated list of summary fields to include in org summary payloadCount
orgConfig Instance Owned Organization Post N Object containing configurations for the new organization Instance Owned Organization Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Organization The newly created organization

Error Responses

Code Type Description
400 Error Error if malformed request