invantive documentation
Invantive Support ForumsLog In / Sign Up

AdminUsersListByFlag: Discourse Admin Users List by Flag

read only REST

  • Catalog: Discourse
  • Schema: Users
  • Label: Admin Users List by Flag

Returns a list of users

Can only retrieve data.

Summary

Returns a list of users

API Source

  • Endpoint: /admin/users/list/{flag}.json
  • Operation: get /admin/users/list/{flag}.json

Performance Characteristics

Characteristic Value
Average access latency (ms) 243
Write rows per minute 219

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
ascending ``
flag `` Values: active, new, staff, suspended, blocked, suspect.
order `` Values: created, last_emailed, seen, username, email, trust_level, days_visited, posts_read, topics_viewed, posts, read_time.
show_emails ``

Table Columns

The columns of the table AdminUsersListByFlag are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
active char Active filters on the platform, writable, active
admin char Administrator filters on the platform, writable, admin
avatar_template varchar2 Avatar Template filters on the platform, writable, avatar_template
blocked char Blocked filters on the platform, writable, blocked
created_at varchar2 Created at filters on the platform, writable, created_at
created_at_age varchar2 Created at Age filters on the platform, writable, created_at_age
days_visited int64 Days Visited filters on the platform, writable, days_visited
email varchar2 Email filters on the platform, writable, email
flag_level int64 Flag Level filters on the platform, writable, flag_level
id int64 ID filters on the platform, writable, id
last_emailed_age varchar2 Last Emailed Age filters on the platform, writable, last_emailed_age
last_emailed_at varchar2 Last Emailed at filters on the platform, writable, last_emailed_at
last_seen_age varchar2 Last Seen Age filters on the platform, writable, last_seen_age
last_seen_at varchar2 Last Seen at filters on the platform, writable, last_seen_at
moderator char Moderator filters on the platform, writable, moderator
post_count int64 #Posts filters on the platform, writable, post_count
posts_read_count int64 Posts Read Count filters on the platform, writable, posts_read_count
staged char Staged filters on the platform, writable, staged
suspended varchar2 Suspended writable The JSON text of the nested object.
suspended_at varchar2 Suspended at writable The JSON text of the nested object.
suspended_till varchar2 Suspended till writable The JSON text of the nested object.
time_read varchar2 Time Read filters on the platform, writable, time_read
title varchar2 Title filters on the platform, writable, title
topics_entered int64 Topics Entered filters on the platform, writable, topics_entered
trust_level int64 Trust Level filters on the platform, writable, trust_level
trust_level_locked char Trust Level Locked filters on the platform, writable, trust_level_locked
username varchar2 User Name filters on the platform, writable, username
username_lower varchar2 Username Lowercase filters on the platform, writable, username_lower

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

Changes of This Table, 26.0 to 27.0

  • - blocked
  • ~ created_at_age (database_data_type: varchar2 → decimal)
  • ~ created_at_age (dotnet_data_type: string → decimal)
  • - flag_level
  • ~ last_emailed_age (database_data_type: varchar2 → decimal)
  • ~ last_emailed_age (dotnet_data_type: string → decimal)
  • ~ last_seen_age (database_data_type: varchar2 → decimal)
  • ~ last_seen_age (dotnet_data_type: string → decimal)
  • - suspended
  • - suspended_at
  • - suspended_till
  • ~ time_read (database_data_type: varchar2 → int64)
  • ~ time_read (dotnet_data_type: string → int64)
  • - trust_level_locked
  • - username_lower

7 more changes

Parameter ascending is removed from Discourse.Users.AdminUsersListByFlag

A call that passes the parameter fails after the upgrade.

What to Do

Check statements, views and scripts that use it before the upgrade.

  • can break a statement
  • importance 4
Parameter asc is added to Discourse.Users.AdminUsersListByFlag

Optional.

  • importance 2
Parameter email is added to Discourse.Users.AdminUsersListByFlag

Optional.

  • importance 2
Parameter ip is added to Discourse.Users.AdminUsersListByFlag

Optional.

  • importance 2
Parameter stats is added to Discourse.Users.AdminUsersListByFlag

Optional.

  • importance 2

  • + manual_locked_trust_level (varchar2)
  • + name (varchar2)

All changes of the driver, 26.0 to 27.0