API Docs for: 2.6
Show:

arch_authentication Class

Module: authentication

The architect component that exposes authentication module.

Methods

authenticate

(
  • accessKeyId
  • password
  • cb
)

It's the authenticate method provided by authentication module.

Parameters:

  • accessKeyId String

    The access key used to authenticate, e.g. the username

  • password String

    The password of the account

  • cb Function

    The callback function

authenticateRemoteSite

(
  • accessKeyId
  • password
  • cb
)

It's the authenticateRemoteSite method provided by authentication module.

Parameters:

  • accessKeyId String

    The access key used to authenticate, e.g. the username

  • password String

    The password of the account

  • cb Function

    The callback function

calculateToken

(
  • accessKeyId
  • password
  • nonce
)

It's the calculateToken method provided by authentication module.

Parameters:

  • accessKeyId String

    The access key used to authenticate, e.g. the username

  • password String

    The password of the account

  • nonce String

    It is used to create the HMAC-SHA1 token

EVT_COMP_READY

()

It's the EVT_COMP_READY property provided by authentication module.

getNonce

(
  • accessKeyId
  • password
)
String

It's the getNonce method provided by authentication module.

Parameters:

  • accessKeyId String

    The access key identifier used to create the token.

  • password String

    The password of the account

Returns:

String:

The SHA1 nonce.

getRemoteSiteName

()

It's the getRemoteSiteName method provided by authentication module.

getTokenExpirationTimeout

()

It's the getTokenExpirationTimeout method provided by authentication module.

isAutoUpdateTokenExpires

() Boolean

It's the isAutoUpdateTokenExpires method provided by authentication module.

Returns:

Boolean:

True if the automatic update is active.

isRemoteSiteAlreadyLoggedIn

()

It's the isRemoteSiteAlreadyLoggedIn method provided by authentication module.

isUnautheCallEnabled

()

It's the isUnautheCallEnabled method provided by authentication module.

on

()

It's the on method provided by authentication module.

removeToken

(
  • accessKeyId
)

It's the removeToken method provided by authentication module.

Parameters:

  • accessKeyId String

    The access key.

updateTokenExpires

()

It's the updateTokenExpires method provided by authentication module.

verifyToken

(
  • token
)

It's the verifyToken method provided by authentication module.

Parameters:

  • token String

    The token to be checked.

Properties

IDLOG

String private final

The module identifier used by the logger.

Default: [arch_authentication]