Class: AuthToken

@nginstack/engine/lib/security/AuthToken~ AuthToken


new AuthToken(scope [, data] [, offlineAuth])

Esta classe é responsável por gerar um token de autorização para ser executado posteriormente em um script especificado. O token de autorização é um mecanismo que permite o usuário do sistema delegar uma autorização de login para uso posterior ou em outro Engine. Com a posse do token, um script pode "logar" na sessão em nome do usuário que autorizou o token.
Após um token ter sido criado, ele deve ser autorizado através dos métodos Security#authorizeToken ou Session#authorizeToken.
Um token de autorização pode ser atualizado através do método Security#updateAuthToken onde é permitido apenas alterar propriedades que não alterem a chave. Caso um token não seja desejado, ele pode ser revogado através do método Security#revokeAuthToken.

Parameters:
Name Type Argument Description
scope String | Number

URI ou chave do script que poderá fazer uso do token.

data string <optional>

Dados opcionais vinculados ao token.

offlineAuth boolean <optional>

Indica se o token poderá ser utilizado off-line. Atualmente não é possível criar tokens offline, apenas é possível autenticar/restaurar token criados enquanto a conexão ainda está online.

See:
  • Security#authorizeToken
  • Security#restoreAuthToken
  • Security#updateAuthToken
  • Security#revokeAuthToken
  • Security#revokeAuthTokenByKey
  • Session#authorizeToken
  • Session#updateAuthToken
  • Session#revokeAuthTokenByKey
  • Session#loginByAuthToken
  • ngin.js.ScriptRunner#loginByAuthToken
Example
var AuthToken = require('@nginstack/engine/lib/security/AuthToken');
var token = new AuthToken(<AUTHORIZED_SCRIPT_KEY>, '{num: 10}', false);
token.description = 'Atualização de valores relativos aos produtos.';
token.expires = new Date(2019, 11, 1);
session.authorizeToken(token);

Members


data :String|Number

Dados vinculados ao token.

Type:
  • String | Number

description :string

Descrição que indique o propósito de utilização deste token.

Type:
  • string

expires :Date

Data de validade deste token. Caso este valor seja nulo o token irá durar 30 dias.

Type:
  • Date

offlineAuth :boolean

Indica se o token poderá ser utilizado off-line. Atualmente não é possível criar tokens offline, apenas é possível autenticar/restaurar token criados enquanto a conexão ainda está online.

Type:
  • boolean

scope :String|Number

URI ou chave do script que poderá utilizar o token de autorização.

Type:
  • String | Number

userKey :number

Chave do usuário que autorizou o token. A sessão que logar utilizando este token, irá executar em nome deste usuário.

Type:
  • number