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

Methods

create remove block unblock changePassword listTokens generateToken revokeToken

Methods

create

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

  • Create a user in HSM.

    Parameters

    Returns Promise<boolean>

    Returns true if the user was created successfully.

    Throws

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

    Throws

    Throws exception if userId or password are invalid.

    See

    Example code: Creating a user

remove

  • remove(userId): Promise<boolean>

  • Removes a user from HSM.

    Parameters

    Returns Promise<boolean>

    Returns true if the user was successfully removed.

    Throws

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

    Throws

    Throws exception if userId is invalid.

    See

    Example code: Removing a user

block

  • block(userId): Promise<boolean>

  • Blocks a user in HSM.

    Parameters

    Returns Promise<boolean>

    See

    Example code: Blocking a user

unblock

  • unblock(userId): Promise<boolean>

  • Unlocks a user in HSM.

    Parameters

    Returns Promise<boolean>

    See

    Example code: Unlocking a user

changePassword

  • changePassword(newPassword): Promise<boolean>

  • Changes the authenticated user's password.

    Parameters

    Returns Promise<boolean>

    Returns true if the password was changed successfully.

    Throws

    Throws exception if an error occurs when changing the password.

    Throws

    Throws exception if new password is invalid.

    See

    Example code: Changing the access password

listTokens

  • listTokens(): Promise<string[]>

  • Lists the tokens of the authenticated user.

    Returns Promise<string[]>

    Returns an array with the user's tokens.

    Throws

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

    Throws

    Throws exception if token is invalid.

    See

    Example code: Listing access tokens

generateToken

  • generateToken(expiration?): Promise<string>

  • Generates a token for the authenticated user.

    Parameters

    • Optionalexpiration: Date

      Token expiration date. Default: No expiration.

    Returns Promise<string>

    Returns the generated token.

    Throws

    Throws exception if an error occurs when generating the token.

    Throws

    Throws exception if expiration date is invalid.

    See

    Example code: Generating an access token

revokeToken

  • revokeToken(token): Promise<boolean>

  • Revoke an authenticated user's token.

    Parameters

    • token: string

      Token to be revoked. The token generated by the generateToken method or returned by the listTokens method.

    Returns Promise<boolean>

    Returns true if the token was successfully revoked.

    Throws

    Throws exception if an error occurs when revoking the token.

    Throws

    Throws exception if token is invalid.

    See

    Example code: Revoking an access token

Settings

On This Page

Methods