Hierarchy

  • User

Methods

  • Description

    Bloqueia um usuário no HSM.

    Parameters

    • userId: string

      Identificador do usuário no HSM. Tamanho máximo de MAX_USR_LEN.

    Returns Promise<boolean>

  • Description

    Altera a senha do usuário autenticado.

    Returns

    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.

    Parameters

    Returns Promise<boolean>

  • Description

    Cria um usuário no HSM.

    Returns

    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.

    Parameters

    • userId: string

      Identificador do usuário no HSM. Tamanho máximo de MAX_USR_LEN.

    • password: string

      Senha do usuário no HSM. Tamanho máximo de MAX_USR_PWD_LEN.

    • Optional permissions: USER_PERMISSIONS[]

      Permissões do usuário no HSM. Default: NOP.

    Returns Promise<boolean>

  • Description

    Gera um token para o usuário autenticado.

    Returns

    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.

    Parameters

    • Optional expiration: Date

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

    Returns Promise<string>

  • Description

    Lista os tokens do usuário atenticado.

    Returns

    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.

    Returns Promise<string[]>

  • Description

    Remove um usuário do HSM.

    Returns

    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.

    Parameters

    • userId: string

      Identificador do usuário no HSM. Tamanho máximo de MAX_USR_LEN.

    Returns Promise<boolean>

  • Description

    Revoga um token do usuário autenticado.

    Returns

    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.

    Parameters

    • token: string

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

    Returns Promise<boolean>

  • Description

    Desbloqueia um usuário no HSM.

    Parameters

    • userId: string

      Identificador do usuário no HSM. Tamanho máximo de MAX_USR_LEN.

    Returns Promise<boolean>