( Return to API Overview )

Available methods

addTrust
getDetails
listChannelsConsumed
listChannelsProvided
listOrgs
listSystemsAffected
listTrusts
removeTrust

Description

Contains methods to access common organization trust information available from the web interface.

Namespace: org.trusts

Method: addTrust

Description:
Add an organization to the list of trusted organizations.

Parameters:

string sessionKey
int orgId
int trustOrgId

Returns:

int - 1 on success, exception thrown otherwise.

Method: getDetails

Description:
The trust details about an organization given the organization's ID.

Parameters:

string sessionKey
int trustOrgId - Id of the trusted organization

Returns:

struct - org trust details dateTime.iso8601 "created" - Date the organization was created dateTime.iso8601 "trusted_since" - Date the organization was defined as trusted int "channels_provided" - Number of channels provided by the organization. int "channels_consumed" - Number of channels consumed by the organization. int "systems_migrated_to" - Number of systems migrated to the organization. int "systems_migrated_from" - Number of systems migrated from the organization.

Method: listChannelsConsumed

Description:
Lists all software channels that the organization given may consume from the user's organization.

Parameters:

string sessionKey
int trustOrgId - Id of the trusted organization

Returns:

array: struct - channel info int "channel_id" string "channel_name" int "packages" int "systems"

Method: listChannelsProvided

Description:
Lists all software channels that the organization given is providing to the user's organization.

Parameters:

string sessionKey
int trustOrgId - Id of the trusted organization

Returns:

array: struct - channel info int "channel_id" string "channel_name" int "packages" int "systems"

Method: listOrgs

Description:
List all organanizations trusted by the user's organization.

Parameters:

string sessionKey

Returns:

array: struct - trusted organizations int "org_id" string "org_name" int "shared_channels"

Description:
Get a list of systems within the trusted organization that would be affected if the trust relationship was removed. This basically lists systems that are sharing at least (1) package.

Parameters:

string sessionKey
int orgId
string trustOrgId

Returns:

array: struct - affected systems int "systemId" string "systemName"

Method: listTrusts

Description:
Returns the list of trusted organizations.

Parameters:

string sessionKey
int orgId

Returns:

array: struct - trusted organizations int "orgId" string "orgName" bool "trustEnabled"

Method: removeTrust

Description:
Remove an organization to the list of trusted organizations.

Parameters:

string sessionKey
int orgId
int trustOrgId

Returns:

int - 1 on success, exception thrown otherwise.

Generated on 10/5/2015