Class: UsersUAA

UsersUAA

Manage Users on Cloud Foundry UAA

Constructor

new UsersUAA(endPoint)

Constructor
Parameters:
Name Type Description
endPoint String [UAA endpoint]
Source:

Methods

add(uaaOptions) → {JSON}

Add an User on UAA https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-APIs.rst#create-a-user-post-users http://www.simplecloud.info/specs/draft-scim-api-01.html#create-resource
Parameters:
Name Type Description
uaaOptions JSON [user options]
Source:
Returns:
[return a JSON response]
Type
JSON

getUsers(searchOptions) → {JSON}

Get users http://www.simplecloud.info/specs/draft-scim-api-01.html#get-resources-ops
Parameters:
Name Type Description
searchOptions JSON [searchOptions]
Source:
Returns:
[return a JSON response]
Type
JSON
Example
?filter=userName eq 'demo4'"

login(username, password) → {JSon}

Method to authenticate with Cloud Foundry UAA
Parameters:
Name Type Description
username String [username]
password String [password]
Source:
Returns:
[UAA Response]
Type
JSon

refreshToken(refreshToken) → {JSON}

Method to refresh a Token https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-Tokens.md
Parameters:
Name Type Description
refreshToken String [Oauth refresh token]
Source:
Returns:
[Response]
Type
JSON

remove(uaaGuid) → {JSON}

Remove an User http://www.simplecloud.info/specs/draft-scim-api-01.html#delete-resource
Parameters:
Name Type Description
uaaGuid String [uaa guid]
Source:
Returns:
[return a JSON response]
Type
JSON

setEndPoint(endPoint) → {void}

Set endpoint
Parameters:
Name Type Description
endPoint String [UAA endpoint]
Source:
Returns:
Type
void

setToken(token) → {void}

Set token
Parameters:
Name Type Description
token JSON [Oauth token from UAA]
Source:
Returns:
Type
void

updatePassword(uaaGuid, uaaOptions) → {JSON}

Update Password [PENDING] https://github.com/cloudfoundry/uaa/blob/master/docs/UAA-APIs.rst#create-a-user-post-users http://www.simplecloud.info/specs/draft-scim-api-01.html#create-resource
Parameters:
Name Type Description
uaaGuid JSON [uaa guid]
uaaOptions JSON [user options]
Source:
Returns:
[return a JSON response]
Type
JSON