Class: Users

Users

Manage Users

Constructor

new Users(endPoint)

Parameters:

Name	Type	Description
`endPoint`	String	[CC endpoint]

Source:

model/cloudcontroller/Users.js, line 8

Methods

add(userOptions) → {JSON}

Add a User http://apidocs.cloudfoundry.org/222/users/creating_a_user.html

Parameters:

Name	Type	Description
`userOptions`	JSON	[user options]

Source:

model/cloudcontroller/Users.js, line 26

Returns:

[return a JSON response]

Type: JSON

associateOrganization(userGuid, orgGuid) → {JSON}

Associate User with an Organization http://apidocs.cloudfoundry.org/222/users/associate_organization_with_the_user.html

Parameters:

Name	Type	Description
`userGuid`	String	[user guid]
`orgGuid`	String	[space guid]

Source:

model/cloudcontroller/Users.js, line 116

Returns:

[return a JSON response]

Type: JSON

associateSpace(userGuid, spaceGuid) → {JSON}

Associate User with a Space http://apidocs.cloudfoundry.org/222/users/associate_space_with_the_user.html

Parameters:

Name	Type	Description
`userGuid`	String	[user guid]
`spaceGuid`	String	[space guid]

Source:

model/cloudcontroller/Users.js, line 93

Returns:

[return a JSON response]

Type: JSON

getUsers() → {JSON}

Get Users http://apidocs.cloudfoundry.org/222/users/list_all_users.html

Source:

model/cloudcontroller/Users.js, line 70

Returns:

[return a JSON response]

Type: JSON

remove(guid) → {JSON}

Delete an User http://apidocs.cloudfoundry.org/222/users/delete_a_particular_user.html

Parameters:

Name	Type	Description
`guid`	String	[user guid]

Source:

model/cloudcontroller/Users.js, line 49

Returns:

[return a JSON response]

Type: JSON