Interface User

interface User {
    create(userId: string, password: string, permissions?: USER_PERMISSIONS[]): Promise<boolean>;
    remove(userId: string): Promise<boolean>;
    block(userId: string): Promise<boolean>;
    unblock(userId: string): Promise<boolean>;
    changePassword(newPassword: string): Promise<boolean>;
    listTokens(): Promise<string[]>;
    generateToken(expiration?: Date): Promise<string>;
    revokeToken(token: string): Promise<boolean>;
}

Methods

create remove block unblock changePassword listTokens generateToken revokeToken

Methods

create

  • create(userId, password, permissions?): Promise<boolean>

  • Cria um usuário no HSM.

    Parameters

    Returns Promise<boolean>

    Retorna true se o usuário foi criado com sucesso.

    Throws

    Lança exceção caso ocorra algum erro ao criar o usuário.

    Throws

    Lança exceção caso o userId ou password sejam inválidos.

    See

    Código de exemplo: Criando um usuário

remove

  • remove(userId): Promise<boolean>

  • Remove um usuário do HSM.

    Parameters

    Returns Promise<boolean>

    Retorna true se o usuário foi removido com sucesso.

    Throws

    Lança exceção caso ocorra algum erro ao remover o usuário.

    Throws

    Lança exceção caso o userId seja inválido.

    See

    Código de exemplo: Removendo um usuário

block

  • block(userId): Promise<boolean>

  • Bloqueia um usuário no HSM.

    Parameters

    Returns Promise<boolean>

    See

    Código de exemplo: Bloqueando um usuário

unblock

  • unblock(userId): Promise<boolean>

  • Desbloqueia um usuário no HSM.

    Parameters

    Returns Promise<boolean>

    See

    Código de exemplo: Desbloqueando um usuário

changePassword

  • changePassword(newPassword): Promise<boolean>

  • Altera a senha do usuário autenticado.

    Parameters

    Returns Promise<boolean>

    Retorna true se a senha foi alterada com sucesso.

    Throws

    Lança exceção caso ocorra algum erro ao alterar a senha.

    Throws

    Lança exceção caso a nova senha seja inválida.

    See

    Código de exemplo: Alterando a senha de acesso

listTokens

  • listTokens(): Promise<string[]>

  • Lista os tokens do usuário atenticado.

    Returns Promise<string[]>

    Retorna um array com os tokens do usuário.

    Throws

    Lança exceção caso ocorra algum erro ao listar os tokens.

    Throws

    Lança exceção caso o token seja inválido.

    See

    Código de exemplo: Listando tokens de acesso

generateToken

  • generateToken(expiration?): Promise<string>

  • Gera um token para o usuário autenticado.

    Parameters

    • Optionalexpiration: Date

      Data de expiração do token. Default: Sem expiração.

    Returns Promise<string>

    Retorna o token gerado.

    Throws

    Lança exceção caso ocorra algum erro ao gerar o token.

    Throws

    Lança exceção caso a data de expiração seja inválida.

    See

    Código de exemplo: Gerando um token de acesso

revokeToken

  • revokeToken(token): Promise<boolean>

  • Revoga um token do usuário autenticado.

    Parameters

    • token: string

      Token a ser revogado. O token gerado pelo método generateToken ou retornado pelo método listTokens.

    Returns Promise<boolean>

    Retorna true se o token foi revogado com sucesso.

    Throws

    Lança exceção caso ocorra algum erro ao revogar o token.

    Throws

    Lança exceção caso o token seja inválido.

    See

    Código de exemplo: Revogando um token de acesso

Settings

On This Page

Methods