Olympe SDK

Interface: ServerConnector

olympe.auth. ServerConnector

Connector used by the auth manager

Methods

<abstract> getConfiguredIDPs()

Gets the Identity Providers (IDP) that are currently configured.

Returns:

A map of Identity Providers (name, protocol).

Type
Map.<string, string>

<abstract> getOpenIDBaseURL()

Gets the base URL for the openID IDP service.

Returns:
Type
string

<abstract> getRoleMembers(roleTag, authorisationToken, callback)

Retrieve the users associated to the specified role.

Parameters:
Name Type Description
roleTag string
authorisationToken string
callback function

<abstract> getUserFromNameId(nameId, authorisationToken, callback)

Retrieve the user tag associated to the specified name ID.

Parameters:
Name Type Description
nameId string
authorisationToken string
callback function

<abstract> getUserFromToken(token, authorisationToken, callback)

Retrieve the user tag associated to the specified token. It uses the specified authorisation token to authenticate the request.

Parameters:
Name Type Description
token string
authorisationToken string
callback function

<abstract> getUserRoles(authorisationToken, callback)

Retrieve the roles of the user providing the authorisation token.

Parameters:
Name Type Description
authorisationToken string
callback function

<abstract> onOffline(callback)

Register a callback called every time the VM becomes disconnected from the server. Directly call the callback if currently offline

Parameters:
Name Type Description
callback olympe.auth.ServerConnector.DisconnectionCallback

<abstract> onOnline(callback)

Register a callback called every time the VM gets connected to the server. Directly call the callback if currently online

Parameters:
Name Type Description
callback olympe.auth.ServerConnector.ConnectionCallback

<abstract> sendKeepAlive(callback)

Send an activity message to refresh the activity timer of the token

Parameters:
Name Type Description
callback function

<abstract> sendLogout(callback)

Send a logout request.

Parameters:
Name Type Description
callback function

<abstract> setLogoutHandler(callback)

Register the handler to call when a logout event is received

Parameters:
Name Type Description
callback olympe.auth.Manager.LogoutCallback

Type Definitions

ConnectionCallback()

DisconnectionCallback(previousConnectionTime)

Parameters:
Name Type Description
previousConnectionTime number