API JavaScript HSM Dinamo
    theme_preparing_search_index

    kind_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>;
    }
    theme_index

    kind_plural_method

    create remove block unblock changePassword listTokens generateToken revokeToken

    kind_plural_method

    • Cria um usuário no HSM.

      kind_plural_parameter

      theme_returns Promise<boolean>

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

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

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

      Código de exemplo: Criando um usuário

    • Remove um usuário do HSM.

      kind_plural_parameter

      theme_returns Promise<boolean>

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

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

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

      Código de exemplo: Removendo um usuário

    • Bloqueia um usuário no HSM.

      kind_plural_parameter

      theme_returns Promise<boolean>

      Código de exemplo: Bloqueando um usuário

    • Desbloqueia um usuário no HSM.

      kind_plural_parameter

      theme_returns Promise<boolean>

      Código de exemplo: Desbloqueando um usuário

    • Altera a senha do usuário autenticado.

      kind_plural_parameter

      theme_returns Promise<boolean>

      Retorna true se a senha foi alterada com sucesso.

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

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

      Código de exemplo: Alterando a senha de acesso

    • Lista os tokens do usuário atenticado.

      theme_returns Promise<string[]>

      Retorna um array com os tokens do usuário.

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

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

      Código de exemplo: Listando tokens de acesso

    • Gera um token para o usuário autenticado.

      kind_plural_parameter

      • flag_optionalexpiration: Date

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

      theme_returns Promise<string>

      Retorna o token gerado.

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

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

      Código de exemplo: Gerando um token de acesso

    • Revoga um token do usuário autenticado.

      kind_plural_parameter

      • token: string

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

      theme_returns Promise<boolean>

      Retorna true se o token foi revogado com sucesso.

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

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

      Código de exemplo: Revogando um token de acesso

    theme_settings

    theme_on_this_page

    kind_plural_method