SDK de Credenciais

Você poderá desenvolver integrações ou formulários que modificam, criam ou até mesmo removem perfis de usuário usando scripts de back-end.

User Credentials Service

O serviço de credenciais pode ser acessado pela chave inpaas.core.user.credentials.

require("inpaas.core.user.credentials");

UserCredentials Model

O model de User Credentials é o mesmo em todos os métodos dessa biblioteca. Você receberá os dados nessa estrutura ao acessar os métodos, ou deverá enviá-los dessa mesma forma.

{
    "id": 963,
    "key": "login",
    "trustedIdPId": null,
    "lastLogin": 1502891909407,
    "expired": false,
    "expireAt": 1502841939974,
    "mfa": false,
    "blocked": {
        "date": 1502841939974,
        "userId": 7
    }
}
AtributoTipoDescrição
idNumberÉ o id da credencial, usado apenas para controle interno.
keyStringÉ o login do usuário.
secretStringÉ a senha do usuário, esse valor nunca é retornado pelos métodos de busca.
Mas deve ser enviado em caso de troca de senha, ou com o valor "$reset" caso deseje enviar um link de acesso ao usuário.
trustedIdPIdNumberÉ o id do provedor de acesso confiável.

Em credenciais com senha, esse atributo não existe ou possui o valor null.
lastLoginTimestampRepresenta o momento do último login efetuado usando essa credencial.
expiredBooleanIdentifica se uma credencial está expirada.
expiredAtTimestampRepresenta o momento da expiração dessa credencial de usuário.
mfaBooleanIdentifica se essa credencial requer ou não um duplo fator de autenticação.
blockedObjetoO objeto blocked existirá quando uma credencial for bloqueada pelo administrador ou por alguma restrição de segurança.

findByUserId(userId)

O método findByUserId retorna a lista de credenciais de usuário no modelo informado acima. O parâmetro userId é um número e deve ser informado.

return require("inpaas.core.user.credentials").findByUserId(1);

setCredentials(userId, credentials)

O método setCredentials define a lista de credenciais do usuário no modelo informado acima. O parâmetro userId é um número e deve ser informado.

require("inpaas.core.user.credentials").setCredentials(1, [
            {
                "id": 967,
                "key": "login",
                "lastLogin": 1502891909407,
                "expired": false
            }
        ]);

O parâmetro credentials deve ser informado em formato de array Javascript, com todas as credenciais do usuário.

Esse método fará a manutenção completa das credenciais, criando, atualizando ou removendo as credenciais do usuário.

❗️

Métodos Descontinuados

Os demais métodos usados em versões anteriores, como create, block ou reset podem ser descontinuados em próximas versões e não devem mais ser utilizados.