Interface UserApi<CustomFields>

interface UserApi {
    acceptInvitation(input): Promise<AcceptInvitationResponse>;
    changeEmail(input): Promise<UserResponse<CustomFields>>;
    changePassword(input): Promise<UserResponse<CustomFields>>;
    createInvitation(input): Promise<CreateInvitationResponse>;
    createUser(input): Promise<UserResponse<CustomFields>>;
    deactivateUser(input): Promise<void>;
    deleteInvitation(input): Promise<void>;
    deleteUser(id): Promise<void>;
    getRequiredVersion(): string;
    getUser(id): Promise<null | UserResponse<CustomFields>>;
    listInvitations(input): Promise<PaginatedResponse<InvitationResponse>>;
    listUsers(input): Promise<PaginatedBackendResponse<UserResponse<CustomFields>>>;
    listUsers(input): Promise<PaginatedResponse<UserResponse<CustomFields>>>;
    listUsers(input): Promise<PaginatedBackendResponse<UserResponse<CustomFields>> | PaginatedResponse<UserResponse<CustomFields>>>;
    listUsers(): Promise<PaginatedBackendResponse<UserResponse<CustomFields>>>;
    lockUser(input): Promise<NoContentType>;
    ping(): Promise<PingResponse>;
    resetPassword(input): Promise<void>;
    sendResetPasswordEmail(input): Promise<void>;
    sendVerificationEmail(input?): Promise<void>;
    unlockUser(input): Promise<NoContentType>;
    updateUser(id, input): Promise<UserResponse<CustomFields>>;
    verifyChangeEmail(input): Promise<void>;
    verifyEmail(input): Promise<void>;
}

Type Parameters

  • CustomFields = unknown

Hierarchy

Implemented by

Methods

acceptInvitation changeEmail changePassword createInvitation createUser deactivateUser deleteInvitation deleteUser getRequiredVersion getUser listInvitations listUsers lockUser ping resetPassword sendResetPasswordEmail sendVerificationEmail unlockUser updateUser verifyChangeEmail verifyEmail

Methods

acceptInvitation

changeEmail

changePassword

createInvitation

createUser

deactivateUser

deleteInvitation

deleteUser

  • deleteUser(id): Promise<void>

  • Deletes a user.

    Parameters

    • id: string

    Returns Promise<void>

getRequiredVersion

  • getRequiredVersion(): string

  • On setup, we can call getRequiredVersion and ping() to confirm that the service exists and that it is of a matching version semantically E.g. if required version is ~2.5 and the api returns 2.6.3, then no issue If returns 3.0.1, should log a warning If returns 1.0.2, should throw error saying it isn't new enough

    Returns string

getUser

listInvitations

listUsers

lockUser

ping

resetPassword

  • resetPassword(input): Promise<void>

  • Reset the password for a user.

    Requires a password reset token generated by the sendResetPasswordEmail method.

    Parameters

    • input: {
          password: string;
          token: string;
      }
      • password: string
      • token: string

    Returns Promise<void>

sendResetPasswordEmail

  • sendResetPasswordEmail(input): Promise<void>

  • Trigger a password reset email to be sent to the user. Will throw errors if the email does not match or the feature is disabled.

    Parameters

    • input: {
          email: string;
      }
      • email: string

    Returns Promise<void>

sendVerificationEmail

  • sendVerificationEmail(input?): Promise<void>

  • Trigger a email verification for the user. If user id isn't provided, defaults to currently logged in user.

    Parameters

    • Optional input: {
          userId?: string;
      }
      • Optional userId?: string

    Returns Promise<void>

unlockUser

updateUser

verifyChangeEmail

  • verifyChangeEmail(input): Promise<void>

  • Verify the change of email for a user. This will update the email in the user's profile.

    Parameters

    • input: {
          token: string;
      }
      • token: string

    Returns Promise<void>

verifyEmail

  • verifyEmail(input): Promise<void>

  • Verify the email for a user. User id is contained inside the given token. This id does not need to match the current user at all (cookies vs bearer auth have no effect).

    Parameters

    • input: {
          token: string;
      }
      • token: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc