Class: Users

Users

new Users(endPoint)

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

Methods

add(token_type, access_token, userOptions) → {JSON}

Add a User http://apidocs.cloudfoundry.org/222/users/creating_a_user.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
userOptions JSON [user options]
Source:
Returns:
[return a JSON response]
Type
JSON

associateOrganization(token_type, access_token, user_guid, org_guid) → {JSON}

Associate User with an Organization http://apidocs.cloudfoundry.org/222/users/associate_organization_with_the_user.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
user_guid String [user guid]
org_guid String [space guid]
Source:
Returns:
[return a JSON response]
Type
JSON

associateSpace(token_type, access_token, user_guid, space_guid) → {JSON}

Associate User with a Space http://apidocs.cloudfoundry.org/222/users/associate_space_with_the_user.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
user_guid String [user guid]
space_guid String [space guid]
Source:
Returns:
[return a JSON response]
Type
JSON

getUsers(token_type, access_token) → {JSON}

Get Users http://apidocs.cloudfoundry.org/222/users/list_all_users.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
Source:
Returns:
[return a JSON response]
Type
JSON

remove(token_type, access_token, user_guid) → {JSON}

Delete an User http://apidocs.cloudfoundry.org/222/users/delete_a_particular_user.html
Parameters:
Name Type Description
token_type String [Authentication type]
access_token String [Authentication token]
user_guid String [user guid]
Source:
Returns:
[return a JSON response]
Type
JSON

setEndPoint(endPoint)

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