Class: Token

olympe.auth. Token

Authenticated token


new Token(user, userTag, nonce [, payload])

Parameters:
Name Type Argument Description
user string
userTag string
nonce string
payload Object <optional>

Methods


<static> unserialize(str)

Creates a new token from a serialized string

This method will typically received a string like this one as parameter : admin|014831d95fd7d12b8568|34bc7db9-1a0a-470c-ac18-9a7155494fc1

This method simply parses the string with | as delimiter and constructs a new Token with the 3 resulting elements (user, userTag and nonce).

This method is obviously the counterpart of the serialize method.

Parameters:
Name Type Description
str string

Serialized token string

Throws:

If the serialized token string is invalid

Type
Error
Returns:
Type
olympe.auth.Token

getFullToken()

Gets the SAML token if it exists. It will be zipped & base64 encoded XML.

Returns:
Type
string

getNonce()

Gets the authenticated nonce

Returns:
Type
string

getPayload()

Gets nameId

Returns:
Type
Object

getUser()

Gets the authenticated user name

Returns:
Type
string

getUserTag()

Gets the authenticated user tag

Returns:
Type
string

serialize()

Serializes the token

Returns:
Type
string