element-hq / element-hq/synapse

Add an Admin API to look up users by and list all threepids

Open
#13,490 0 comments 0 reactions 0 assignees View on GitHub
A-Admin-API A-Social Login O-Uncommon S-Minor T-Enhancement
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#13490](https://github.com/matrix-org/synapse/issues/13490).

---

**Description:**

- [x] There should be a way to look up users by their threepid without needing to connect to the Synapse database directly. For example, a new optional parameter on https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html?highlight=threepid#list-accounts.
- Done in #14405
- [ ] It would also be useful if the List Accounts API could optionally include threepids when listing users to get an overview of all existing threepids on your server. Instead of needing to do `SELECT * FROM user_threepids;`

Contributor guide

Open the contributing guide

Research direction

First review the completed lookup portion in #14405, then read the List Accounts API documentation at user_admin_api.html. Inspect how the List Accounts API currently exposes users and compare it with the user_threepids table mentioned in the issue. Done means callers can optionally include all users’ threepids when listing accounts.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.