2021-06-03 10:21:02 -06:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Admin API - Synapse< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "../../../favicon.svg" >
< link rel = "shortcut icon" href = "../../../favicon.png" >
< link rel = "stylesheet" href = "../../../css/variables.css" >
< link rel = "stylesheet" href = "../../../css/general.css" >
< link rel = "stylesheet" href = "../../../css/chrome.css" >
< link rel = "stylesheet" href = "../../../css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "../../../FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "../../../fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "../../../highlight.css" >
< link rel = "stylesheet" href = "../../../tomorrow-night.css" >
< link rel = "stylesheet" href = "../../../ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< link rel = "stylesheet" href = "../../../docs/website_files/table-of-contents.css" >
< link rel = "stylesheet" href = "../../../docs/website_files/remove-nav-buttons.css" >
< link rel = "stylesheet" href = "../../../docs/website_files/indent-section-headers.css" >
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "../../../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2023-08-07 11:37:08 -06:00
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < li class = "part-title" > Introduction< / li > < li class = "chapter-item expanded " > < a href = "../../../welcome_and_overview.html" > Welcome and Overview< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Setup< / li > < li class = "chapter-item expanded " > < a href = "../../../setup/installation.html" > Installation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../postgres.html" > Using Postgres< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../reverse_proxy.html" > Configuring a Reverse Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../setup/forward_proxy.html" > Configuring a Forward/Outbound Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../turn-howto.html" > Configuring a Turn Server< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../../../setup/turn/coturn.html" > coturn TURN server< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../setup/turn/eturnal.html" > eturnal TURN server< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../../../delegate.html" > Delegation< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Upgrading< / li > < li class = "chapter-item expanded " > < a href = "../../../upgrade.html" > Upgrading between Synapse Versions< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Usage< / li > < li class = "chapter-item expanded " > < a href = "../../../federate.html" > Federation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/index.html" > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/config_documentation.html" > Configuration Manual< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/homeserver_sample_config.html" > Homeserver Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/logging_sample_config.html" > Logging Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../structured_logging.html" > Structured Logging< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../templates.html" > Templates< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/user_authentication/index.html" > User Authentication< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/user_authentication/single_sign_on/index.html" > Single-Sign On< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../../../openid.html" > OpenID Connect< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/user_authentication/single_sign_on/saml.html" > SAML< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/user_authentication/single_sign_on/cas.html" > CAS< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../sso_mapping_providers.html" > SSO Mapping Providers< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../../../password_auth_providers.html" > Password Auth Providers< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../jwt.html" > JSON Web Tokens< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../usage/configuration/user_authentication/refresh_tokens.html" > Refresh Tokens< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../../../CAPTCHA_SETUP.html" > Registration Captcha< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../application_services.html" > Application Services< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../server_notices.html" > Server Notices< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../consent_tracking.html" > Consent Tracking< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../user_directory.html" > User Directory< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../message_retention_policies.html" > Message Retention Policies< / a > < / li > < li class = "chapter-item expanded " > < a href = "../../../modules/index.html" > Pluggable Mod
2021-06-03 10:21:02 -06:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > Synapse< / h1 >
< div class = "right-buttons" >
< a href = "../../../print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< a href = "https://github.com/matrix-org/synapse" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< a href = "https://github.com/matrix-org/synapse/edit/develop/docs/usage/administration/admin_api/README.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
<!-- Page table of contents -->
< div class = "sidetoc" >
< nav class = "pagetoc" > < / nav >
< / div >
< h1 id = "the-admin-api" > < a class = "header" href = "#the-admin-api" > The Admin API< / a > < / h1 >
< h2 id = "authenticate-as-a-server-admin" > < a class = "header" href = "#authenticate-as-a-server-admin" > Authenticate as a server admin< / a > < / h2 >
< p > Many of the API calls in the admin api will require an < code > access_token< / code > for a
server admin. (Note that a server admin is distinct from a room admin.)< / p >
2022-08-03 04:16:07 -06:00
< p > An existing user can be marked as a server admin by updating the database directly.< / p >
2023-01-05 11:18:54 -07:00
< p > Check your < a href = "../../configuration/config_documentation.html#database" > database settings< / a > in the configuration file, connect to the correct database using either < code > psql [database name]< / code > (if using PostgreSQL) or < code > sqlite3 path/to/your/database.db< / code > (if using SQLite) and elevate the user < code > @foo:bar.com< / code > to administrator.< / p >
2021-06-03 10:21:02 -06:00
< pre > < code class = "language-sql" > UPDATE users SET admin = 1 WHERE name = '@foo:bar.com';
< / code > < / pre >
< p > A new server admin user can also be created using the < code > register_new_matrix_user< / code >
2022-03-02 06:00:49 -07:00
command. This is a script that is distributed as part of synapse. It is possibly
2021-06-03 10:21:02 -06:00
already on your < code > $PATH< / code > depending on how Synapse was installed.< / p >
< p > Finding your user's < code > access_token< / code > is client-dependent, but will usually be shown in the client's settings.< / p >
< h2 id = "making-an-admin-api-request" > < a class = "header" href = "#making-an-admin-api-request" > Making an Admin API request< / a > < / h2 >
2022-11-21 04:41:11 -07:00
< p > For security reasons, we < a href = "../../../reverse_proxy.html#synapse-administration-endpoints" > recommend< / a >
2022-07-13 12:34:07 -06:00
that the Admin API (< code > /_synapse/admin/...< / code > ) should be hidden from public view using a
reverse proxy. This means you should typically query the Admin API from a terminal on
the machine which runs Synapse.< / p >
2021-06-03 10:21:02 -06:00
< p > Once you have your < code > access_token< / code > , you will need to authenticate each request to an Admin API endpoint by
providing the token as either a query parameter or a request header. To add it as a request header in cURL:< / p >
< pre > < code class = "language-sh" > curl --header " Authorization: Bearer < access_token> " < the_rest_of_your_API_request>
< / code > < / pre >
2022-07-13 12:34:07 -06:00
< p > For example, suppose we want to
2023-01-05 11:18:54 -07:00
< a href = "../../../admin_api/user_admin_api.html#query-user-account" > query the account< / a > of the user
2022-07-13 12:34:07 -06:00
< code > @foo:bar.com< / code > . We need an admin access token (e.g.
< code > syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk< / code > ), and we need to know which port
2023-01-05 11:18:54 -07:00
Synapse's < a href = "../../configuration/config_documentation.html#listeners" > < code > client< / code > listener< / a > is listening
2022-07-13 12:34:07 -06:00
on (e.g. < code > 8008< / code > ). Then we can use the following command to request the account
information from the Admin API.< / p >
< pre > < code class = "language-sh" > curl --header " Authorization: Bearer syt_AjfVef2_L33JNpafeif_0feKJfeaf0CQpoZk" -X GET http://127.0.0.1:8008/_synapse/admin/v2/users/@foo:bar.com
< / code > < / pre >
2021-06-03 10:21:02 -06:00
< p > For more details on access tokens in Matrix, please refer to the complete
< a href = "https://matrix.org/docs/spec/client_server/r0.6.1#using-access-tokens" > matrix spec documentation< / a > .< / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "../../../usage/administration/index.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../../../admin_api/account_validity.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< a rel = "prev" href = "../../../usage/administration/index.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../../../admin_api/account_validity.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "../../../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../../mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../../searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../../clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../../highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../../../book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< script type = "text/javascript" src = "../../../docs/website_files/table-of-contents.js" > < / script >
< / body >
< / html >
