JavaScript HSM API Dinamo
    Preparing search index...

    User interface

    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>;
    }
    Index

    Methods

    create remove block unblock changePassword listTokens generateToken revokeToken

    Methods

    • Create a user in HSM.

      Parameters

      Returns Promise<boolean>

      Returns true if the user is successfully created.

      Throws an exception if an error occurs when creating the user.

      Throws an exception if userId or password are invalid.

      Example code: Creating a user

    • Removes a user from HSM.

      Parameters

      Returns Promise<boolean>

      Returns true if the user is successfully removed.

      Throws an exception if an error occurs when removing the user.

      Throws an exception if the userId is invalid.

      Example code: Removing a user

    • Blocks a user in HSM.

      Parameters

      Returns Promise<boolean>

      Returns true if the user is successfully blocked.

      Throws an exception if an error occurs when blocking the user.

      Example code: Blocking a user

    • Unlocks a user in HSM.

      Parameters

      Returns Promise<boolean>

      Returns true if the user is successfully unlocked.

      Throws an exception if an error occurs when unlocking the user.

      Example code: Unlocking a user

    • Changes the authenticated user's password.

      Parameters

      Returns Promise<boolean>

      Returns true if the password was changed successfully.

      Throws an exception if an error occurs when changing the password.

      Throws an exception if the new password is invalid.

      Example code: Changing the access password

    • Lists the authenticated user's tokens.

      Returns Promise<string[]>

      Returns an array with the user's tokens.

      Throws an exception if an error occurs when listing the tokens.

      Example code: Listing access tokens

    • Generates a token for the authenticated user.

      Parameters

      • Optionalexpiration: Date

        Token expiration date. Default: No expiration.

      Returns Promise<string>

      Returns the generated token.

      Throws an exception if an error occurs when generating the token.

      Throws an exception if the expiration date is invalid.

      Example code: Generating an access token

    • Revoke an authenticated user's token.

      Parameters

      Returns Promise<boolean>

      Returns true if the token is successfully revoked.

      Throws an exception if an error occurs when revoking the token.

      Throws an exception if the token is invalid.

      Example code: Revoking an access token

    Settings

    On This Page

    Methods