Class StaffUsers

constructor

• new StaffUsers(e621: E621<NoV2Options> | undefined, client: Client): StaffUsers

  e621 may be omitted (pass undefined) when constructing a module standalone, without the main E621 client, to keep bundles tree-shakable. Convenience methods on models returned by this module that call back into other modules via this.e621 will throw in that case.

  Parameters

  • e621: E621<NoV2Options> | undefined
  • client: Client

  Returns StaffUsers

Static ReadonlymoduleKey

altList

• altList(): Promise<[number, number[]][]>
  Requires Api Key Auth

  You must be Admin+.

  Returns Promise<[number, number[]][]>

  Operation Id

  staff/users#alt_list

  See

  Documentation for more details.

anonymize

• anonymize(id: number): Promise<string>
  Requires Api Key Auth

  You must have the bd staff user flag. Cannot be used on staff.

  Parameters

  • id: number

  Returns Promise<string>

  Operation Id

  staff/users#anonymize_confirm

  See

  Documentation for more details.

totpReset

• totpReset(id: number): Promise<string>
  Requires Api Key Auth

  You must be Admin+. You must have the bd staff flag if the user is Staff+.

  Parameters

  • id: number

  Returns Promise<string>

  Operation Id

  staff/users#totp_reset

  See

  Documentation for more details.

update

• update(id: number, options: UpdateStaffUserOptions): Promise<null>
  Requires Api Key Auth

  You must be Admin+. If editing an Admin+, you must be Owner+.

  Parameters

  • id: number
  • options: UpdateStaffUserOptions

  Returns Promise<null>

  Operation Id

  staff/users#update

  See

  Documentation for more details.

updateBlacklist

• updateBlacklist(id: number, blacklisted_tags: string): Promise<string>
  Requires Api Key Auth

  Parameters

  • id: number
  • blacklisted_tags: string

  Returns Promise<string>

  Operation Id

  staff/users#update_blacklist

  See

  Documentation for more details.