Projeto

O Componente SSO Conector foi criado como implementação do Plugin do SSO desenvolvido pela WIZ(https://github.com/wizsolucoes/vanilla-wiz-sso/) de forma a atender as necessidades do WizEngagement.

O Componente é desenvolvido em Vanilla Javascript

Sumário

• Responsáveis
• Instalando
• Dependências
• Bases de dados
• APIs
• Builds e testes (CI)
• Release (CD)
• Contribuição

Responsáveis

• Gerente: Newton Batista [email protected]
• PO: Lizangler Campos [email protected]
• Dev Web: Stéfan de Lima Amaral [email protected]
• Cordenador TI: Touré Holder [email protected]
• Gerente TI: Daniel Nogueira [email protected]

Instalação

Passos para execução do projeto:

1 - instalar dependência

npm install git+<este repositório>

2 - instanciar dependência

import { loginWithCredentials } from '@wizengagement/wessoconector'

3 - chamar a função passando os parâmetros necessários

loginWithCredentials(ssoParams, username, password)

Credenciais

É necessário passar um objeto com os parâmetros de acesso e consumo do serviço SSO da WIZ no seguinte formato:

{
    "clientSecret": "", -> client secret fornecido pela WIZ
    "grantType": "password", -> tipo de autenticação que será feita
    "scope": "", -> escopo onde será feito a autenticação, tbem fornecida pela WIZ
    "apiPath": "", -> URL de consumo da API
    "clientID": "", -> idendificador do cliente
    "options": {
        "autoRefreshToken": true,
        "ssoTimeout": 60000
    }
}

Métodos

loginWithCredentials

Após este método ser chamado, um token será salvo no localStorage e no cookies da aplicação com a chave (auth_data) e poderá ser usado como for necessário. Segue usa utilização:

loginWithCredentials(ssoParams, username, password)

logOut

Após este método ser chamado, os tokens guardados em sessão serão deletados

logOut(ssoParams)

redirectWithAuth

Este método redireciona o usuário logado para a URL informada, passando o objeto gerado ao logar com o SSO e dados adicionais caso necessário.

É necessário passar a URL desejada com a string '%auth_data%' onde deseja que o objeto criptografado seja inserido, de forma semelhante a string '%aditional_data%' para onde deseja que os dados adicionais sejam inseridos.

Segue o Exemplo de URL:

https://wizengagement.com.br?auth=%auth_data%&data=%aditional_data%

Não existe limitação ou regras mais rígidas para o formato da URL ou o formato dos objetos, somente o chaveamento correto na String da URL

A chamada é feita passando a URL para a qual deseja redirecionar e o objeto com dados de apoio do usuário, se este último não for passado é considerado como inexistente.

redirectWithAuth(URL)

ou

redirectWithAuth(URL, aditionalData)

isLogged

Verifica se existe usuário logado e retorna seu token, caso exista.

isLogged(ssoParams)

refreshToken

Revive o token caso logado

refreshToken(ssoParams)

getLoggedUserData

Ao chamar este método, os dados do usuário logado serão retornados

getLoggedUserData()

Dependências

Pacotes/frameworks:

@wizsolucoes/vanilla-wiz-sso

Release

• Prd: N/A
• Hml: N/A