Skip to content

Get the self-edit settings (admin)

GET
/admin/system/users

Returns the same five self-edit settings as getSelfEditGates, for the admin screen.

You need to be signed in with system.config.write or system.admin granted globally, even though this only reads; others get 403. Without a session cookie or bearer token that identifies you, the answer is 401, whether or not public mode is on.

A field with no stored setting, or a stored value that isn’t a boolean, reads as editable, while a stored null reads as locked. If the settings can’t be read at all, every field is reported editable; if reading fails partway, some fields can be reported editable whatever their stored setting, and that answer can be cached. The answer is 200 either way. The values may come from each server’s cache, as for getSelfEditGates.

Which of the five fields people may edit themselves.

Whether each of the five lockable profile fields can be changed by its owner; true means it can.

object
display_name
required
boolean
bio
required
boolean
avatar_url
required
boolean
location
required
boolean
website_url
required
boolean

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed