Class: UsersUAA

UsersUAA

new UsersUAA(endPoint)

Manage Users on Cloud Foundry UAA
Parameters:
Name Type Description
endPoint String [UAA endpoint]
Source:

Methods

add(token_type, access_token, uaa_options) → {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
token_type String [Authentication type]
access_token String [Authentication token]
uaa_options JSON [user options]
Source:
Returns:
[return a JSON response]
Type
JSON

getUsers(token_type, access_token, searchOptions) → {JSON}

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

login(endPoint, username, password) → {JSon}

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

refreshToken(refresh_token) → {JSON}

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

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

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

setEndPoint(endPoint)

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

updatePassword(token_type, access_token, uaa_options) → {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
token_type String [Authentication type]
access_token String [Authentication token]
uaa_options JSON [user options]
Source:
Returns:
[return a JSON response]
Type
JSON