Class: Organizations

Organizations

new Organizations(endPoint)

Manage Organizations in Cloud Foundry
Parameters:
Name Type Description
endPoint String [CC endpoint]
Source:

Methods

add(token_type, access_token, orgOptions)

Add a new organization http://apidocs.cloudfoundry.org/222/organizations/creating_an_organization.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
orgOptions JSon [org options]
Source:

getMemoryUsage(token_type, access_token, org_guid) → {JSON}

Get memory usage from an Organization http://apidocs.cloudfoundry.org/222/organizations/retrieving_organization_memory_usage.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
org_guid String [org guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getOrganizations(token_type, access_token) → {JSON}

Get Organizations http://apidocs.cloudfoundry.org/213/organizations/list_all_organizations.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
Source:
Returns:
[return a JSON response]
Type
JSON

getPrivateDomains(token_type, access_token, org_guid) → {JSON}

Get private domains from an Organizations http://apidocs.cloudfoundry.org/214/organizations/list_all_private_domains_for_the_organization.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
org_guid String [org guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getSummary(token_type, access_token, org_guid) → {JSON}

Get summary from an Organization http://apidocs.cloudfoundry.org/222/organizations/get_organization_summary.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
org_guid String [org guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getUsers(token_type, access_token, org_guid, filter) → {Json}

Get users from an Organization http://apidocs.cloudfoundry.org/222/organizations/list_all_users_for_the_organization.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
org_guid String [org guid]
filter Json [filter to search]
Source:
Returns:
[output]
Type
Json

remove(token_type, access_token, org_guid, orgOptions) → {String}

Remove an Organization http://apidocs.cloudfoundry.org/222/organizations/delete_a_particular_organization.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
org_guid String [org guid]
orgOptions JSon [org options]
Source:
Returns:
[output]
Type
String

setEndPoint(endPoint)

Set endpoint
Parameters:
Name Type Description
endPoint String [CC endpoint]
Source: