CINXE.COM

<!DOCTYPE html> <html class="client-nojs vector-feature-language-in-header-disabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-disabled skin-theme-clientpref-day vector-toc-available" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>API:Account creation - MediaWiki</title> <script>(function(){var className="client-js vector-feature-language-in-header-disabled vector-feature-language-in-main-page-header-disabled vector-feature-sticky-header-disabled vector-feature-page-tools-pinned-disabled vector-feature-toc-pinned-clientpref-1 vector-feature-main-menu-pinned-disabled vector-feature-limited-width-clientpref-1 vector-feature-limited-width-content-enabled vector-feature-custom-font-size-clientpref-1 vector-feature-appearance-pinned-clientpref-1 vector-feature-night-mode-disabled skin-theme-clientpref-day vector-toc-available";var cookie=document.cookie.match(/(?:^|; )mediawikiwikimwclientpreferences=([^;]+)/);if(cookie){cookie[1].split('%2C').forEach(function(pref){className=className.replace(new RegExp('(^| )'+pref.replace(/-clientpref-\w+$|[^\w-]+/g,'')+'-clientpref-\\w+( |$)'),'$1'+pref+'$2');});}document.documentElement.className=className;}());RLCONF={"wgBreakFrames":true,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""], "wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"a1cd3b12-df02-4f9f-86d5-2028acbdea0d","wgCanonicalNamespace":"API","wgCanonicalSpecialPageName":false,"wgNamespaceNumber":104,"wgPageName":"API:Account_creation","wgTitle":"Account creation","wgCurRevisionId":6728511,"wgRevisionId":6728511,"wgArticleId":643758,"wgIsArticle":true,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":["MediaWiki action API"],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"API:Account_creation","wgRelevantArticleId":643758,"wgIsProbablyEditable":true,"wgRelevantPageIsProbablyEditable":true,"wgRestrictionEdit":[],"wgRestrictionMove":[],"wgNoticeProject":"mediawiki","wgCiteReferencePreviewsActive":true,"wgMediaViewerOnClick":true,"wgMediaViewerEnabledByDefault":true,"wgVisualEditor":{ "pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":false,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":20000,"wgInternalRedirectTargetUrl":"/wiki/API:Account_creation","wgTranslatePageTranslation":"source","wgCentralAuthMobileDomain":false,"wgEditSubmitButtonLabelPublish":true,"wgULSPosition":"personal","wgULSisCompactLinksEnabled":true,"wgVector2022LanguageInHeader":false,"wgULSisLanguageSelectorEmpty":false,"wgCheckUserClientHintsHeadersJsApi":["brands","architecture","bitness","fullVersionList","mobile","model","platform","platformVersion"]};RLSTATE={"ext.globalCssJs.user.styles":"ready","site.styles":"ready","user.styles":"ready","ext.globalCssJs.user":"ready","user":"ready","user.options":"loading","ext.translate.tag.languages":"ready","mediawiki.hlist":"ready","mediawiki.apipretty":"ready","ext.pygments":"ready","skins.vector.search.codex.styles": "ready","skins.vector.styles":"ready","skins.vector.icons":"ready","jquery.makeCollapsible.styles":"ready","ext.translate.edit.documentation.styles":"ready","ext.translate":"ready","ext.wikimediamessages.styles":"ready","ext.visualEditor.desktopArticleTarget.noscript":"ready","ext.uls.pt":"ready","wikibase.client.init":"ready","ext.wikimediaBadges":"ready"};RLPAGEMODULES=["mediawiki.action.view.redirect","ext.pygments.view","site","mediawiki.page.ready","jquery.makeCollapsible","mediawiki.toc","skins.vector.js","ext.centralNotice.geoIP","ext.centralNotice.startUp","ext.translate.pagetranslation.uls","ext.urlShortener.toolbar","ext.centralauth.centralautologin","mmv.bootstrap","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming","ext.uls.compactlinks","ext.uls.interface","ext.checkUser.clientHints"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); }];});});</script> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.pygments%2Ctranslate%2CwikimediaBadges%7Cext.translate.edit.documentation.styles%7Cext.translate.tag.languages%7Cext.uls.pt%7Cext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediamessages.styles%7Cjquery.makeCollapsible.styles%7Cmediawiki.apipretty%2Chlist%7Cskins.vector.icons%2Cstyles%7Cskins.vector.search.codex.styles%7Cwikibase.client.init&only=styles&skin=vector-2022"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=vector-2022"></script> <meta name="ResourceLoaderDynamicStyles" content=""> <link rel="stylesheet" href="/w/load.php?lang=en&modules=site.styles&only=styles&skin=vector-2022"> <meta name="generator" content="MediaWiki 1.44.0-wmf.5"> <meta name="referrer" content="origin"> <meta name="referrer" content="origin-when-cross-origin"> <meta name="robots" content="max-image-preview:standard"> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="width=1120"> <meta property="og:site_name" content="MediaWiki"> <meta property="og:title" content="API:Account creation - MediaWiki"> <meta property="og:type" content="website"> <link rel="preconnect" href="//upload.wikimedia.org"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//m.mediawiki.org/wiki/API:Account_creation"> <link rel="alternate" type="application/x-wiki" title="Edit" href="/w/index.php?title=API:Account_creation&action=edit"> <link rel="apple-touch-icon" href="/static/apple-touch/mediawiki.png"> <link rel="icon" href="/static/favicon/mediawiki.ico"> <link rel="search" type="application/opensearchdescription+xml" href="/w/rest.php/v1/search" title="MediaWiki (en)"> <link rel="EditURI" type="application/rsd+xml" href="//www.mediawiki.org/w/api.php?action=rsd"> <link rel="canonical" href="https://www.mediawiki.org/wiki/API:Account_creation"> <link rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/"> <link rel="alternate" type="application/atom+xml" title="MediaWiki Atom feed" href="/w/index.php?title=Special:RecentChanges&feed=atom"> <link rel="dns-prefetch" href="//meta.wikimedia.org" /> <link rel="dns-prefetch" href="//login.wikimedia.org"> </head> <body class="skin--responsive skin-vector skin-vector-search-vue mediawiki ltr sitedir-ltr mw-hide-empty-elt ns-104 ns-subject mw-editable page-API_Account_creation rootpage-API_Account_creation skin-vector-2022 action-view"><a class="mw-jump-link" href="#bodyContent">Jump to content</a> <div class="vector-header-container"> <header class="vector-header mw-header"> <div class="vector-header-start"> <nav class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-dropdown" class="vector-dropdown vector-main-menu-dropdown vector-button-flush-left vector-button-flush-right" > <input type="checkbox" id="vector-main-menu-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-main-menu-dropdown" class="vector-dropdown-checkbox " aria-label="Main menu" > <label id="vector-main-menu-dropdown-label" for="vector-main-menu-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Main menu </label> <div class="vector-dropdown-content"> <div id="vector-main-menu-unpinned-container" class="vector-unpinned-container"> <div id="vector-main-menu" class="vector-main-menu vector-pinnable-element"> <div class="vector-pinnable-header vector-main-menu-pinnable-header vector-pinnable-header-unpinned" data-feature-name="main-menu-pinned" data-pinnable-element-id="vector-main-menu" data-pinned-container-id="vector-main-menu-pinned-container" data-unpinned-container-id="vector-main-menu-unpinned-container" > <div class="vector-pinnable-header-label">Main menu</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-main-menu.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-main-menu.unpin">hide</button> </div> <div id="p-navigation" class="vector-menu mw-portlet mw-portlet-navigation" > <div class="vector-menu-heading"> Navigation </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-mainpage-description" class="mw-list-item"><a href="/wiki/MediaWiki" title="Visit the main page [z]" accesskey="z">Main page</a></li><li id="n-mw-download" class="mw-list-item"><a href="/wiki/Download">Get MediaWiki</a></li><li id="n-mw-extensions" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Category:Extensions">Get extensions</a></li><li id="n-blog-text" class="mw-list-item"><a href="https://techblog.wikimedia.org/">Tech blog</a></li><li id="n-mw-contribute" class="mw-list-item"><a href="/wiki/Special:MyLanguage/How_to_contribute">Contribute</a></li> </ul> </div> </div> <div id="p-support" class="vector-menu mw-portlet mw-portlet-support" > <div class="vector-menu-heading"> Support </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-help" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Help:Contents" title="The place to find out">User help</a></li><li id="n-mw-faq" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Manual:FAQ">FAQ</a></li><li id="n-mw-manual" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Manual:Contents">Technical manual</a></li><li id="n-mw-supportdesk" class="mw-list-item"><a href="/wiki/Project:Support_desk">Support desk</a></li><li id="n-mw-communication" class="mw-list-item"><a href="/wiki/Special:MyLanguage/Communication">Communication</a></li> </ul> </div> </div> <div id="p-development" class="vector-menu mw-portlet mw-portlet-development" > <div class="vector-menu-heading"> Development </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-mw-developerportal" class="mw-list-item"><a href="https://developer.wikimedia.org/">Developer portal</a></li><li id="n-svn-statistics" class="mw-list-item"><a href="/wiki/Development_statistics">Code statistics</a></li> </ul> </div> </div> <div id="p-mediawiki.org" class="vector-menu mw-portlet mw-portlet-mediawiki_org" > <div class="vector-menu-heading"> mediawiki.org </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="n-portal" class="mw-list-item"><a href="/wiki/Project:Help" title="About the project, what you can do, where to find things">Community portal</a></li><li id="n-recentchanges" class="mw-list-item"><a href="/wiki/Special:RecentChanges" title="A list of recent changes in the wiki [r]" accesskey="r">Recent changes</a></li><li id="n-mw-translate" class="mw-list-item"><a href="/wiki/Special:LanguageStats">Translate content</a></li><li id="n-randompage" class="mw-list-item"><a href="/wiki/Special:Random" title="Load a random page [x]" accesskey="x">Random page</a></li><li id="n-mw-discussion" class="mw-list-item"><a href="/wiki/Project:Village_Pump">Village pump</a></li><li id="n-Sandboxlink-portlet-label" class="mw-list-item"><a href="/wiki/Project:Sandbox">Sandbox</a></li> </ul> </div> </div> <div id="p-lang" class="vector-menu mw-portlet mw-portlet-lang" > <div class="vector-menu-heading"> In other languages </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> <div class="after-portlet after-portlet-lang"><a href="https://www.wikidata.org/wiki/Special:NewItem?site=mediawikiwiki&page=API%3AAccount+creation" title="Add interlanguage links" class="wbc-editpage">Add links</a></div> </div> </div> </div> </div> </div> </div> </nav> <a href="/wiki/MediaWiki" class="mw-logo"> <img class="mw-logo-icon" src="/static/images/icons/mediawikiwiki.svg" alt="" aria-hidden="true" height="50" width="50"> <img class="mw-logo-wordmark" alt="MediaWiki" src="/static/images/mobile/copyright/mediawikiwiki-wordmark.svg" style="width: 7.5em; height: 1.125em;"> </a> </div> <div class="vector-header-end"> <div id="p-search" role="search" class="vector-search-box-vue vector-search-box-collapses vector-search-box-show-thumbnail vector-search-box-auto-expand-width vector-search-box"> <a href="/wiki/Special:Search" class="cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only search-toggle" title="Search MediaWiki [f]" accesskey="f"> Search </a> <div class="vector-typeahead-search-container"> <div class="cdx-typeahead-search cdx-typeahead-search--show-thumbnail cdx-typeahead-search--auto-expand-width"> <form action="/w/index.php" id="searchform" class="cdx-search-input cdx-search-input--has-end-button"> <div id="simpleSearch" class="cdx-search-input__input-wrapper" data-search-loc="header-moved"> <div class="cdx-text-input cdx-text-input--has-start-icon"> <input class="cdx-text-input__input" type="search" name="search" placeholder="Search MediaWiki" aria-label="Search MediaWiki" autocapitalize="sentences" title="Search MediaWiki [f]" accesskey="f" id="searchInput" > </div> <input type="hidden" name="title" value="Special:Search"> </div> <button class="cdx-button cdx-search-input__end-button">Search</button> </form> </div> </div> </div> <nav class="vector-user-links vector-user-links-wide" aria-label="Personal tools"> <div class="vector-user-links-main"> <div id="p-vector-user-menu-preferences" class="vector-menu mw-portlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-uls" class="mw-list-item active user-links-collapsible-item"><a data-mw="interface" href="#" class="uls-trigger cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet"> English</a> </li> </ul> </div> </div> <div id="p-vector-user-menu-userpage" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-dropdown" class="vector-dropdown " title="Change the appearance of the page's font size, width, and color" > <input type="checkbox" id="vector-appearance-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-appearance-dropdown" class="vector-dropdown-checkbox " aria-label="Appearance" > <label id="vector-appearance-dropdown-label" for="vector-appearance-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Appearance </label> <div class="vector-dropdown-content"> <div id="vector-appearance-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <div id="p-vector-user-menu-notifications" class="vector-menu mw-portlet emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> <div id="p-vector-user-menu-overflow" class="vector-menu mw-portlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="https://donate.wikimedia.org/?wmf_source=donate&wmf_medium=sidebar&wmf_campaign=www.mediawiki.org&uselang=en" class="">Donate</a> </li> <li id="pt-createaccount-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:CreateAccount&returnto=API%3AAccount+creation" title="You are encouraged to create an account and log in; however, it is not mandatory" class="">Create account</a> </li> <li id="pt-login-2" class="user-links-collapsible-item mw-list-item user-links-collapsible-item"><a data-mw="interface" href="/w/index.php?title=Special:UserLogin&returnto=API%3AAccount+creation" title="You are encouraged to log in; however, it is not mandatory [o]" accesskey="o" class="">Log in</a> </li> </ul> </div> </div> </div> <div id="vector-user-links-dropdown" class="vector-dropdown vector-user-menu vector-button-flush-right vector-user-menu-logged-out" title="More options" > <input type="checkbox" id="vector-user-links-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-user-links-dropdown" class="vector-dropdown-checkbox " aria-label="Personal tools" > <label id="vector-user-links-dropdown-label" for="vector-user-links-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Personal tools </label> <div class="vector-dropdown-content"> <div id="p-personal" class="vector-menu mw-portlet mw-portlet-personal user-links-collapsible-item" title="User menu" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-sitesupport" class="user-links-collapsible-item mw-list-item"><a href="https://donate.wikimedia.org/?wmf_source=donate&wmf_medium=sidebar&wmf_campaign=www.mediawiki.org&uselang=en">Donate</a></li><li id="pt-createaccount" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:CreateAccount&returnto=API%3AAccount+creation" title="You are encouraged to create an account and log in; however, it is not mandatory"> Create account</a></li><li id="pt-login" class="user-links-collapsible-item mw-list-item"><a href="/w/index.php?title=Special:UserLogin&returnto=API%3AAccount+creation" title="You are encouraged to log in; however, it is not mandatory [o]" accesskey="o"> Log in</a></li> </ul> </div> </div> <div id="p-user-menu-anon-editor" class="vector-menu mw-portlet mw-portlet-user-menu-anon-editor" > <div class="vector-menu-heading"> Pages for logged out editors <a href="/wiki/Help:Introduction" aria-label="Learn more about editing">learn more</a> </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="pt-anoncontribs" class="mw-list-item"><a href="/wiki/Special:MyContributions" title="A list of edits made from this IP address [y]" accesskey="y">Contributions</a></li><li id="pt-anontalk" class="mw-list-item"><a href="/wiki/Special:MyTalk" title="Discussion about edits from this IP address [n]" accesskey="n">Talk</a></li> </ul> </div> </div> </div> </div> </nav> </div> </header> </div> <div class="mw-page-container"> <div class="mw-page-container-inner"> <div class="vector-sitenotice-container"> <div id="siteNotice"></div> </div> <div class="vector-column-start"> <div class="vector-main-menu-container"> <div id="mw-navigation"> <nav id="mw-panel" class="vector-main-menu-landmark" aria-label="Site"> <div id="vector-main-menu-pinned-container" class="vector-pinned-container"> </div> </nav> </div> </div> <div class="vector-sticky-pinned-container"> <nav id="mw-panel-toc" aria-label="Contents" data-event-name="ui.sidebar-toc" class="mw-table-of-contents-container vector-toc-landmark"> <div id="vector-toc-pinned-container" class="vector-pinned-container"> <div id="vector-toc" class="vector-toc vector-pinnable-element"> <div class="vector-pinnable-header vector-toc-pinnable-header vector-pinnable-header-pinned" data-feature-name="toc-pinned" data-pinnable-element-id="vector-toc" > <h2 class="vector-pinnable-header-label">Contents</h2> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-toc.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-toc.unpin">hide</button> </div> <ul class="vector-toc-contents" id="mw-panel-toc-list"> <li id="toc-mw-content-text" class="vector-toc-list-item vector-toc-level-1"> <a href="#" class="vector-toc-link"> <div class="vector-toc-text">Beginning</div> </a> </li> <li id="toc-API_documentation" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#API_documentation"> <div class="vector-toc-text"> 1 API documentation </div> </a> <ul id="toc-API_documentation-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Creating_an_account" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Creating_an_account"> <div class="vector-toc-text"> 2 Creating an account </div> </a> <button aria-controls="toc-Creating_an_account-sublist" class="cdx-button cdx-button--weight-quiet cdx-button--icon-only vector-toc-toggle"> Toggle Creating an account subsection </button> <ul id="toc-Creating_an_account-sublist" class="vector-toc-list"> <li id="toc-Example_1:_Process_on_a_wiki_without_special_authentication_extensions" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Example_1:_Process_on_a_wiki_without_special_authentication_extensions"> <div class="vector-toc-text"> 2.1 Example 1: Process on a wiki without special authentication extensions </div> </a> <ul id="toc-Example_1:_Process_on_a_wiki_without_special_authentication_extensions-sublist" class="vector-toc-list"> <li id="toc-POST_request" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#POST_request"> <div class="vector-toc-text"> 2.1.1 POST request </div> </a> <ul id="toc-POST_request-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Response" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Response"> <div class="vector-toc-text"> 2.1.2 Response </div> </a> <ul id="toc-Response-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Sample_code" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Sample_code"> <div class="vector-toc-text"> 2.1.3 Sample code </div> </a> <ul id="toc-Sample_code-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> <li id="toc-Python" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Python"> <div class="vector-toc-text"> 2.2 Python </div> </a> <ul id="toc-Python-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-PHP" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#PHP"> <div class="vector-toc-text"> 2.3 PHP </div> </a> <ul id="toc-PHP-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-JavaScript" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#JavaScript"> <div class="vector-toc-text"> 2.4 JavaScript </div> </a> <ul id="toc-JavaScript-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-MediaWiki_JS" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#MediaWiki_JS"> <div class="vector-toc-text"> 2.5 MediaWiki JS </div> </a> <ul id="toc-MediaWiki_JS-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Example_2:_Process_on_a_wiki_with_a_CAPTCHA_extension" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Example_2:_Process_on_a_wiki_with_a_CAPTCHA_extension"> <div class="vector-toc-text"> 2.6 Example 2: Process on a wiki with a CAPTCHA extension </div> </a> <ul id="toc-Example_2:_Process_on_a_wiki_with_a_CAPTCHA_extension-sublist" class="vector-toc-list"> <li id="toc-First_step:_Fetch_fields_available_from_API:Authmanagerinfo_and_token_from_API:Tokens" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#First_step:_Fetch_fields_available_from_API:Authmanagerinfo_and_token_from_API:Tokens"> <div class="vector-toc-text"> 2.6.1 First step: Fetch fields available from API:Authmanagerinfo and token from API:Tokens </div> </a> <ul id="toc-First_step:_Fetch_fields_available_from_API:Authmanagerinfo_and_token_from_API:Tokens-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Second_step:_Send_a_post_request_along_with_a_create_account_token,_user_information_and_return_URL" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Second_step:_Send_a_post_request_along_with_a_create_account_token,_user_information_and_return_URL"> <div class="vector-toc-text"> 2.6.2 Second step: Send a post request along with a create account token, user information and return URL </div> </a> <ul id="toc-Second_step:_Send_a_post_request_along_with_a_create_account_token,_user_information_and_return_URL-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Sample_Code_2" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Sample_Code_2"> <div class="vector-toc-text"> 2.6.3 Sample Code </div> </a> <ul id="toc-Sample_Code_2-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> <li id="toc-Example_3:_Account_creation_on_a_wiki_with_a_CAPTCHA,_an_OpenID_extension,_and_a_two-factor_authentication_extension_enabled" class="vector-toc-list-item vector-toc-level-2"> <a class="vector-toc-link" href="#Example_3:_Account_creation_on_a_wiki_with_a_CAPTCHA,_an_OpenID_extension,_and_a_two-factor_authentication_extension_enabled"> <div class="vector-toc-text"> 2.7 Example 3: Account creation on a wiki with a CAPTCHA, an OpenID extension, and a two-factor authentication extension enabled </div> </a> <ul id="toc-Example_3:_Account_creation_on_a_wiki_with_a_CAPTCHA,_an_OpenID_extension,_and_a_two-factor_authentication_extension_enabled-sublist" class="vector-toc-list"> <li id="toc-First_step:_Fetch_fields_available_from_API:Authmanagerinfo_and_token_from_API:Tokens_2" class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#First_step:_Fetch_fields_available_from_API:Authmanagerinfo_and_token_from_API:Tokens_2"> <div class="vector-toc-text"> 2.7.1 First step: Fetch fields available from API:Authmanagerinfo and token from API:Tokens </div> </a> <ul id="toc-First_step:_Fetch_fields_available_from_API:Authmanagerinfo_and_token_from_API:Tokens_2-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Second_step:_Answer_the_CAPTCHA_and_select_OpenID_authentication." class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Second_step:_Answer_the_CAPTCHA_and_select_OpenID_authentication."> <div class="vector-toc-text"> 2.7.2 Second step: Answer the CAPTCHA and select OpenID authentication. </div> </a> <ul id="toc-Second_step:_Answer_the_CAPTCHA_and_select_OpenID_authentication.-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Third_step:_Back_from_OpenID." class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Third_step:_Back_from_OpenID."> <div class="vector-toc-text"> 2.7.3 Third step: Back from OpenID. </div> </a> <ul id="toc-Third_step:_Back_from_OpenID.-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Fourth_step:_Set_up_two-factor_authentication." class="vector-toc-list-item vector-toc-level-3"> <a class="vector-toc-link" href="#Fourth_step:_Set_up_two-factor_authentication."> <div class="vector-toc-text"> 2.7.4 Fourth step: Set up two-factor authentication. </div> </a> <ul id="toc-Fourth_step:_Set_up_two-factor_authentication.-sublist" class="vector-toc-list"> </ul> </li> </ul> </li> </ul> </li> <li id="toc-Possible_errors" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Possible_errors"> <div class="vector-toc-text"> 3 Possible errors </div> </a> <ul id="toc-Possible_errors-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-Additional_notes" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#Additional_notes"> <div class="vector-toc-text"> 4 Additional notes </div> </a> <ul id="toc-Additional_notes-sublist" class="vector-toc-list"> </ul> </li> <li id="toc-See_also" class="vector-toc-list-item vector-toc-level-1 vector-toc-list-item-expanded"> <a class="vector-toc-link" href="#See_also"> <div class="vector-toc-text"> 5 See also </div> </a> <ul id="toc-See_also-sublist" class="vector-toc-list"> </ul> </li> </ul> </div> </div> </nav> </div> </div> <div class="mw-content-container"> <main id="content" class="mw-body"> <header class="mw-body-header vector-page-titlebar"> <nav aria-label="Contents" class="vector-toc-landmark"> <div id="vector-page-titlebar-toc" class="vector-dropdown vector-page-titlebar-toc vector-button-flush-left" > <input type="checkbox" id="vector-page-titlebar-toc-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-titlebar-toc" class="vector-dropdown-checkbox " aria-label="Toggle the table of contents" > <label id="vector-page-titlebar-toc-label" for="vector-page-titlebar-toc-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet cdx-button--icon-only " aria-hidden="true" > Toggle the table of contents </label> <div class="vector-dropdown-content"> <div id="vector-page-titlebar-toc-unpinned-container" class="vector-unpinned-container"> </div> </div> </div> </nav> <h1 id="firstHeading" class="firstHeading mw-first-heading">API:Account creation</h1> <div class="mw-indicators"> </div> </header> <div class="vector-page-toolbar"> <div class="vector-page-toolbar-container"> <div id="left-navigation"> <nav aria-label="Namespaces"> <div id="p-associated-pages" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-associated-pages" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-nstab-api" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/API:Account_creation" title="View the subject page [c]" accesskey="c">API</a></li><li id="ca-talk" class="vector-tab-noicon mw-list-item"><a href="/wiki/API_talk:Account_creation" rel="discussion" title="Discussion about the content page [t]" accesskey="t">Discussion</a></li> </ul> </div> </div> <div id="vector-variants-dropdown" class="vector-dropdown emptyPortlet" > <input type="checkbox" id="vector-variants-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-variants-dropdown" class="vector-dropdown-checkbox " aria-label="Change language variant" > <label id="vector-variants-dropdown-label" for="vector-variants-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" >English </label> <div class="vector-dropdown-content"> <div id="p-variants" class="vector-menu mw-portlet mw-portlet-variants emptyPortlet" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> </div> </div> </nav> </div> <div id="right-navigation" class="vector-collapsible"> <nav aria-label="Views"> <div id="p-views" class="vector-menu vector-menu-tabs mw-portlet mw-portlet-views" > <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-view" class="selected vector-tab-noicon mw-list-item"><a href="/wiki/API:Account_creation">Read</a></li><li id="ca-edit" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=API:Account_creation&action=edit" title="Edit the source code of this page [e]" accesskey="e">Edit</a></li><li id="ca-history" class="vector-tab-noicon mw-list-item"><a href="/w/index.php?title=API:Account_creation&action=history" title="Past revisions of this page [h]" accesskey="h">View history</a></li> </ul> </div> </div> </nav> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-dropdown" class="vector-dropdown vector-page-tools-dropdown" > <input type="checkbox" id="vector-page-tools-dropdown-checkbox" role="button" aria-haspopup="true" data-event-name="ui.dropdown-vector-page-tools-dropdown" class="vector-dropdown-checkbox " aria-label="Tools" > <label id="vector-page-tools-dropdown-label" for="vector-page-tools-dropdown-checkbox" class="vector-dropdown-label cdx-button cdx-button--fake-button cdx-button--fake-button--enabled cdx-button--weight-quiet" aria-hidden="true" >Tools </label> <div class="vector-dropdown-content"> <div id="vector-page-tools-unpinned-container" class="vector-unpinned-container"> <div id="vector-page-tools" class="vector-page-tools vector-pinnable-element"> <div class="vector-pinnable-header vector-page-tools-pinnable-header vector-pinnable-header-unpinned" data-feature-name="page-tools-pinned" data-pinnable-element-id="vector-page-tools" data-pinned-container-id="vector-page-tools-pinned-container" data-unpinned-container-id="vector-page-tools-unpinned-container" > <div class="vector-pinnable-header-label">Tools</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-page-tools.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-page-tools.unpin">hide</button> </div> <div id="p-cactions" class="vector-menu mw-portlet mw-portlet-cactions emptyPortlet vector-has-collapsible-items" title="More options" > <div class="vector-menu-heading"> Actions </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="ca-more-view" class="selected vector-more-collapsible-item mw-list-item"><a href="/wiki/API:Account_creation">Read</a></li><li id="ca-more-edit" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=API:Account_creation&action=edit" title="Edit the source code of this page [e]" accesskey="e">Edit</a></li><li id="ca-more-history" class="vector-more-collapsible-item mw-list-item"><a href="/w/index.php?title=API:Account_creation&action=history">View history</a></li> </ul> </div> </div> <div id="p-tb" class="vector-menu mw-portlet mw-portlet-tb" > <div class="vector-menu-heading"> General </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="t-whatlinkshere" class="mw-list-item"><a href="/wiki/Special:WhatLinksHere/API:Account_creation" title="A list of all wiki pages that link here [j]" accesskey="j">What links here</a></li><li id="t-recentchangeslinked" class="mw-list-item"><a href="/wiki/Special:RecentChangesLinked/API:Account_creation" rel="nofollow" title="Recent changes in pages linked from this page [k]" accesskey="k">Related changes</a></li><li id="t-upload" class="mw-list-item"><a href="//commons.wikimedia.org/wiki/Special:UploadWizard" title="Upload files [u]" accesskey="u">Upload file</a></li><li id="t-specialpages" class="mw-list-item"><a href="/wiki/Special:SpecialPages" title="A list of all special pages [q]" accesskey="q">Special pages</a></li><li id="t-permalink" class="mw-list-item"><a href="/w/index.php?title=API:Account_creation&oldid=6728511" title="Permanent link to this revision of this page">Permanent link</a></li><li id="t-info" class="mw-list-item"><a href="/w/index.php?title=API:Account_creation&action=info" title="More information about this page">Page information</a></li><li id="t-cite" class="mw-list-item"><a href="/w/index.php?title=Special:CiteThisPage&page=API%3AAccount_creation&id=6728511&wpFormIdentifier=titleform" title="Information on how to cite this page">Cite this page</a></li><li id="t-urlshortener" class="mw-list-item"><a href="/w/index.php?title=Special:UrlShortener&url=https%3A%2F%2Fwww.mediawiki.org%2Fwiki%2FAPI%3AAccount_creation">Get shortened URL</a></li><li id="t-urlshortener-qrcode" class="mw-list-item"><a href="/w/index.php?title=Special:QrCode&url=https%3A%2F%2Fwww.mediawiki.org%2Fwiki%2FAPI%3AAccount_creation">Download QR code</a></li> </ul> </div> </div> <div id="p-coll-print_export" class="vector-menu mw-portlet mw-portlet-coll-print_export" > <div class="vector-menu-heading"> Print/export </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> <li id="coll-create_a_book" class="mw-list-item"><a href="/w/index.php?title=Special:Book&bookcmd=book_creator&referer=API%3AAccount+creation">Create a book</a></li><li id="coll-download-as-rl" class="mw-list-item"><a href="/w/index.php?title=Special:DownloadAsPdf&page=API%3AAccount_creation&action=show-download-screen">Download as PDF</a></li><li id="t-print" class="mw-list-item"><a href="/w/index.php?title=API:Account_creation&printable=yes" title="Printable version of this page [p]" accesskey="p">Printable version</a></li> </ul> </div> </div> <div id="p-wikibase-otherprojects" class="vector-menu mw-portlet mw-portlet-wikibase-otherprojects emptyPortlet" > <div class="vector-menu-heading"> In other projects </div> <div class="vector-menu-content"> <ul class="vector-menu-content-list"> </ul> </div> </div> </div> </div> </div> </div> </nav> </div> </div> </div> <div class="vector-column-end"> <div class="vector-sticky-pinned-container"> <nav class="vector-page-tools-landmark" aria-label="Page tools"> <div id="vector-page-tools-pinned-container" class="vector-pinned-container"> </div> </nav> <nav class="vector-appearance-landmark" aria-label="Appearance"> <div id="vector-appearance-pinned-container" class="vector-pinned-container"> <div id="vector-appearance" class="vector-appearance vector-pinnable-element"> <div class="vector-pinnable-header vector-appearance-pinnable-header vector-pinnable-header-pinned" data-feature-name="appearance-pinned" data-pinnable-element-id="vector-appearance" data-pinned-container-id="vector-appearance-pinned-container" data-unpinned-container-id="vector-appearance-unpinned-container" > <div class="vector-pinnable-header-label">Appearance</div> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-pin-button" data-event-name="pinnable-header.vector-appearance.pin">move to sidebar</button> <button class="vector-pinnable-header-toggle-button vector-pinnable-header-unpin-button" data-event-name="pinnable-header.vector-appearance.unpin">hide</button> </div> </div> </div> </nav> </div> </div> <div id="bodyContent" class="vector-body" aria-labelledby="firstHeading" data-mw-ve-target-container> <div class="vector-body-before-content"> <div id="siteSub" class="noprint">From mediawiki.org</div> </div> <div id="contentSub"><div id="mw-content-subtitle"></div></div> <div id="mw-content-text" class="mw-body-content"><div class="mw-pt-translate-header noprint nomobile" dir="ltr" lang="en"><a href="/w/index.php?title=Special:Translate&group=page-API%3AAccount+creation&action=page&filter=&action_source=translate_page" title="Special:Translate">Translate this page</a></div><div class="mw-content-ltr mw-parser-output" lang="en" dir="ltr"><div class="mw-pt-languages noprint navigation-not-searchable" lang="en" dir="ltr"><div class="mw-pt-languages-label">Languages:</div><ul class="mw-pt-languages-list"><li><a href="/wiki/API:Account_creation/id" class="mw-pt-progress mw-pt-progress--low" title="API:Pengelolaan akun (2% translated)" lang="id" dir="ltr">Bahasa Indonesia</a></li> <li><a href="/wiki/API:Account_creation/de" class="mw-pt-progress mw-pt-progress--complete" title="API:Kontoerstellung (100% translated)" lang="de" dir="ltr">Deutsch</a></li> <li>English</li> <li><a href="/wiki/API:Account_creation/ig" class="mw-pt-progress mw-pt-progress--low" title="API:Account creation/ig (10% translated)" lang="ig" dir="ltr">Igbo</a></li> <li><a href="/wiki/API:Account_creation/tr" class="mw-pt-progress mw-pt-progress--complete" title="API:Hesap oluşturma (100% translated)" lang="tr" dir="ltr">Türkçe</a></li> <li><a href="/wiki/API:Account_creation/diq" class="mw-pt-progress mw-pt-progress--low" title="API:Account creation/diq (6% translated)" lang="diq" dir="ltr">Zazaki</a></li> <li><a href="/wiki/API:Account_creation/da" class="mw-pt-progress mw-pt-progress--low" title="API:Konto oprettelse (13% translated)" lang="da" dir="ltr">dansk</a></li> <li><a href="/wiki/API:Account_creation/es" class="mw-pt-progress mw-pt-progress--complete" title="API:Creación de cuentas (100% translated)" lang="es" dir="ltr">español</a></li> <li><a href="/wiki/API:Account_creation/fr" class="mw-pt-progress mw-pt-progress--complete" title="API:Création de compte (100% translated)" lang="fr" dir="ltr">français</a></li> <li><a href="/wiki/API:Account_creation/it" class="mw-pt-progress mw-pt-progress--low" title="API: Creazione account (2% translated)" lang="it" dir="ltr">italiano</a></li> <li><a href="/wiki/API:Account_creation/hu" class="mw-pt-progress mw-pt-progress--complete" title="API:Fiók létrehozása (100% translated)" lang="hu" dir="ltr">magyar</a></li> <li><a href="/wiki/API:Account_creation/pl" class="mw-pt-progress mw-pt-progress--med" title="API:Utwórz konto (25% translated)" lang="pl" dir="ltr">polski</a></li> <li><a href="/wiki/API:Account_creation/pt" class="mw-pt-progress mw-pt-progress--low" title="API:Criação de contas (6% translated)" lang="pt" dir="ltr">português</a></li> <li><a href="/wiki/API:Account_creation/ro" class="mw-pt-progress mw-pt-progress--low" title="API:Account creation/ro (2% translated)" lang="ro" dir="ltr">română</a></li> <li><a href="/wiki/API:Account_creation/cs" class="mw-pt-progress mw-pt-progress--complete" title="API:Vytvoření účtu (100% translated)" lang="cs" dir="ltr">čeština</a></li> <li><a href="/wiki/API:Account_creation/ru" class="mw-pt-progress mw-pt-progress--high" title="API:Создание учётной записи (98% translated)" lang="ru" dir="ltr">русский</a></li> <li><a href="/wiki/API:Account_creation/uk" class="mw-pt-progress mw-pt-progress--complete" title="API:Створення облікового запису (100% translated)" lang="uk" dir="ltr">українська</a></li> <li><a href="/wiki/API:Account_creation/ar" class="mw-pt-progress mw-pt-progress--complete" title="واجهة برمجة التطبيقات:إنشاء حساب (100% translated)" lang="ar" dir="rtl">العربية</a></li> <li><a href="/wiki/API:Account_creation/hi" class="mw-pt-progress mw-pt-progress--complete" title="API:खाता निर्माण (100% translated)" lang="hi" dir="ltr">हिन्दी</a></li> <li><a href="/wiki/API:Account_creation/th" class="mw-pt-progress mw-pt-progress--med" title="API:สร้างบัญชี (54% translated)" lang="th" dir="ltr">ไทย</a></li> <li><a href="/wiki/API:Account_creation/zh" class="mw-pt-progress mw-pt-progress--complete" title="API:创建账号 (100% translated)" lang="zh" dir="ltr">中文</a></li> <li><a href="/wiki/API:Account_creation/ja" class="mw-pt-progress mw-pt-progress--med" title="API:アカウント作成 (23% translated)" lang="ja" dir="ltr">日本語</a></li> <li><a href="/wiki/API:Account_creation/nan" class="mw-pt-progress mw-pt-progress--med" title="API: Kháu-tsō tshòng-kiàn (38% translated)" lang="nan" dir="ltr">閩南語 / Bân-lâm-gú</a></li> <li><a href="/wiki/API:Account_creation/ko" class="mw-pt-progress mw-pt-progress--med" title="API:계정 생성 (19% translated)" lang="ko" dir="ltr">한국어</a></li></ul></div> <style data-mw-deduplicate="TemplateStyles:r6651108">.mw-parser-output table.ombox{margin:4px 10%;border-collapse:collapse;border:1px solid #a2a9b1;background-color:#f8f9fa;color:#333;box-sizing:border-box}.mw-parser-output .ombox td.mbox-empty-cell{border:none;padding:0;width:1px}.mw-parser-output .ombox th.mbox-text,.mw-parser-output .ombox td.mbox-text{border:none;padding:0.25em 0.9em;width:100%}.mw-parser-output .ombox td.mbox-image{border:none;text-align:center;padding:2px 0 2px 0.9em}.mw-parser-output .ombox td.mbox-imageright{border:none;text-align:center;padding:2px 0.9em 2px 0}.mw-parser-output table.ombox-notice{border-color:#a2a9b1}.mw-parser-output table.ombox-speedy{background-color:#fee7e6;color:#333}.mw-parser-output table.ombox-speedy,.mw-parser-output table.ombox-delete{border-color:#b32424;border-width:2px}.mw-parser-output table.ombox-content{border-color:#f28500}.mw-parser-output table.ombox-style{border-color:#fc3}.mw-parser-output table.ombox-move{border-color:#9932cc}.mw-parser-output table.ombox-protection{border-color:#a2a9b1;border-width:2px}html body.mediawiki .mw-parser-output .ombox.mbox-small{clear:right;float:right;margin:4px 0 4px 1em;box-sizing:border-box;width:238px;font-size:88%;line-height:1.25em}@media screen{html.skin-theme-clientpref-night .mw-parser-output table.ombox{background-color:transparent;color:inherit}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output table.ombox{background-color:transparent;color:inherit}}</style><table class="skin-nightmode-reset-color ombox ombox-content plainlinks" role="presentation" style="display: block; color:#222; border:solid 1px #A8A8A8; padding: .5em 1em; margin:0.5em 0em;"><tbody><tr><td class="mbox-image"><img alt="" src="//upload.wikimedia.org/wikipedia/commons/thumb/f/f6/API_-_The_Noun_Project.svg/30px-API_-_The_Noun_Project.svg.png" decoding="async" width="30" height="30" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/f/f6/API_-_The_Noun_Project.svg/45px-API_-_The_Noun_Project.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/f/f6/API_-_The_Noun_Project.svg/60px-API_-_The_Noun_Project.svg.png 2x" data-file-width="512" data-file-height="512" /></td><td class="mbox-text">This page is part of the <a href="/wiki/Special:MyLanguage/API:Main_page" title="Special:MyLanguage/API:Main page">MediaWiki Action API</a> documentation.</td></tr></tbody></table> <style data-mw-deduplicate="TemplateStyles:r6605224">.mw-parser-output .tpl-sidebar{background-color:var(--background-color-interactive-subtle,#f8f9fa);border:1px solid var(--border-color-divider,#a2a9b1);color:var(--color-base,#202122);width:22em;padding:.2em;text-align:center;line-height:1.4em;font-size:88%}.mw-parser-output .tpl-sidebar-pagedir-ltr,.mw-parser-output .tpl-sidebar.tpl-sidebar-floatright{float:right;clear:right;margin:.5em 0 1em 1em}.mw-parser-output .tpl-sidebar-pagedir-rtl,.mw-parser-output .tpl-sidebar.tpl-sidebar-floatleft{float:left;clear:left;margin:.5em 1em 1em 0}.mw-parser-output .tpl-sidebar.tpl-sidebar-floatnone{float:none;clear:both;margin:.5em 0 1em 1em}.mw-parser-output .tpl-sidebar>caption{padding-bottom:.2em;font-size:125%;line-height:1.2em;font-weight:bold}.mw-parser-output .tpl-sidebar>tbody>tr>th,.mw-parser-output .tpl-sidebar>tbody>tr>td{padding:0}.mw-parser-output .tpl-sidebar .tpl-sidebar-topimage>td{padding:.4em 0}.mw-parser-output .tpl-sidebar-imagecaption{padding-top:.2em;line-height:1.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-pretitle>td{padding-top:.4em;line-height:1.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-topimage+.tpl-sidebar-pretitle>td{padding-top:.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-title>th{padding:.2em .4em .2em;font-size:145%;line-height:1.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-pretitle+.tpl-sidebar-title>th{padding-top:0}.mw-parser-output .tpl-sidebar .tpl-sidebar-image>td{padding:.2em 0 .4em}.mw-parser-output .tpl-sidebar .tpl-sidebar-abovebelow>td{padding:.3em .4em;font-weight:bold}.mw-parser-output .tpl-sidebar .tpl-sidebar-heading>th{padding-top:.2em}.mw-parser-output .tpl-sidebar .tpl-sidebar-image~.tpl-sidebar-heading-first>th{padding-top:.4em}.mw-parser-output .tpl-sidebar .tpl-sidebar-content>td{padding-bottom:.2em}.mw-parser-output .tpl-sidebar :not(.tpl-sidebar-heading)+.tpl-sidebar-content-first>td{padding-top:.2em}.mw-parser-output .tpl-sidebar-navbar>td{font-size:115%}.mw-parser-output .tpl-sidebar-pagedir-ltr .tpl-sidebar-navbar>td{text-align:right}.mw-parser-output .tpl-sidebar-pagedir-rtl .tpl-sidebar-navbar>td{text-align:left}</style><table class="vertical-navbox tpl-sidebar tpl-sidebar-pagedir-ltr nowraplinks noprint" role="navigation" style="width:22em; border-spacing: 0.4em 0; text-align: left; padding: 1.5em; padding: min(1.5em, 2%); margin: 0 0 2em 2em; width: 320px; max-width: 40%;"><tbody><tr class="tpl-sidebar-title"> <th class="" style="font-size: 19px; font-weight: 700; padding: 0;"><a href="/wiki/Special:MyLanguage/API:Main_page" title="Special:MyLanguage/API:Main page">MediaWiki Action API</a><a href="/wiki/API:Main_page" title="API:Main page"> </a></th> </tr><tr class="tpl-sidebar-heading tpl-sidebar-heading-first"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Basics</th> </tr><tr class="tpl-sidebar-content tpl-sidebar-content-first"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Etiquette" title="Special:MyLanguage/API:Etiquette">Etiquette and usage guidelines</a><a href="/wiki/API:Etiquette" title="API:Etiquette"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Query" title="Special:MyLanguage/API:Query">All query modules</a><a href="/wiki/API:Query" title="API:Query"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Properties" title="Special:MyLanguage/API:Properties">All page properties</a><a href="/wiki/API:Properties" title="API:Properties"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Lists" title="Special:MyLanguage/API:Lists">All list modules</a><a href="/wiki/API:Lists" title="API:Lists"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Meta" title="Special:MyLanguage/API:Meta">All meta modules</a><a href="/wiki/API:Meta" title="API:Meta"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Data_formats" title="Special:MyLanguage/API:Data formats">Output formats</a><a href="/wiki/API:Data_formats" title="API:Data formats"> </a></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Authentication</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Tokens" title="Special:MyLanguage/API:Tokens">Get tokens for data modifying operations</a><a href="/wiki/API:Tokens" title="API:Tokens"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Login" title="Special:MyLanguage/API:Login">Login</a><a href="/wiki/API:Login" title="API:Login"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Logout" title="Special:MyLanguage/API:Logout">Logout</a><a href="/wiki/API:Logout" title="API:Logout"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Assert" title="Special:MyLanguage/API:Assert">Verifying authentication (assertions)</a><a href="/wiki/API:Assert" title="API:Assert"> </a></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Accounts and Users</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Account_creation" title="Special:MyLanguage/API:Account creation">Create an account</a><a class="mw-selflink selflink"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Block" title="Special:MyLanguage/API:Block">Block or unblock a user</a><a href="/wiki/API:Block" title="API:Block"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Userinfo" title="Special:MyLanguage/API:Userinfo">Get info about the current user</a><a href="/wiki/API:Userinfo" title="API:Userinfo"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Watchlist_feed" title="Special:MyLanguage/API:Watchlist feed">Get the current user's watchlist as a feed</a><a href="/wiki/API:Watchlist_feed" title="API:Watchlist feed"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Options" title="Special:MyLanguage/API:Options">Change user options</a><a href="/wiki/API:Options" title="API:Options"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:User_group_membership" title="Special:MyLanguage/API:User group membership">Change user group membership</a><a href="/wiki/API:User_group_membership" title="API:User group membership"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Emailuser" title="Special:MyLanguage/API:Emailuser">Send an email</a><a href="/wiki/API:Emailuser" title="API:Emailuser"> </a></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Page Operations</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Edit" title="Special:MyLanguage/API:Edit">Create and edit a page</a><a href="/wiki/API:Edit" title="API:Edit"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Get_the_contents_of_a_page" title="Special:MyLanguage/API:Get the contents of a page">Get the contents of a page</a><a href="/wiki/API:Get_the_contents_of_a_page" title="API:Get the contents of a page"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Upload" title="Special:MyLanguage/API:Upload">Upload a file</a><a href="/wiki/API:Upload" title="API:Upload"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Import" title="Special:MyLanguage/API:Import">Import a page</a><a href="/wiki/API:Import" title="API:Import"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Delete" title="Special:MyLanguage/API:Delete">Delete a page</a><a href="/wiki/API:Delete" title="API:Delete"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Parsing_wikitext" title="Special:MyLanguage/API:Parsing wikitext">Parse content of a page</a><a href="/wiki/API:Parsing_wikitext" title="API:Parsing wikitext"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Watch" title="Special:MyLanguage/API:Watch">Watch or unwatch a page</a><a href="/wiki/API:Watch" title="API:Watch"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Purge" title="Special:MyLanguage/API:Purge">Purge cache for page(s)</a><a href="/wiki/API:Purge" title="API:Purge"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Rollback" title="Special:MyLanguage/API:Rollback">Rollback a page</a><a href="/wiki/API:Rollback" title="API:Rollback"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Move" title="Special:MyLanguage/API:Move">Move a page</a><a href="/wiki/API:Move" title="API:Move"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Patrol" title="Special:MyLanguage/API:Patrol">Patrol a page or revision</a><a href="/wiki/API:Patrol" title="API:Patrol"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Undelete" title="Special:MyLanguage/API:Undelete">Restore revisions of a deleted page</a><a href="/wiki/API:Undelete" title="API:Undelete"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Protect" title="Special:MyLanguage/API:Protect">Change a page's protection level</a><a href="/wiki/API:Protect" title="API:Protect"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:SetPageLanguage" title="Special:MyLanguage/API:SetPageLanguage">Change a page's language</a><a href="/wiki/API:SetPageLanguage" title="API:SetPageLanguage"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Changing_wiki_content" title="Special:MyLanguage/API:Changing wiki content">More...</a><a href="/wiki/API:Changing_wiki_content" title="API:Changing wiki content"> </a></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Search</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Opensearch" title="Special:MyLanguage/API:Opensearch">Search wiki pages by title (OpenSearch)</a><a href="/wiki/API:Opensearch" title="API:Opensearch"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Search" title="Special:MyLanguage/API:Search">Advanced search for wiki pages by title or text</a><a href="/wiki/API:Search" title="API:Search"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Geosearch" title="Special:MyLanguage/API:Geosearch">Search wiki pages near a location</a><a href="/wiki/API:Geosearch" title="API:Geosearch"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Languagesearch" title="Special:MyLanguage/API:Languagesearch">Search for a language name</a><a href="/wiki/API:Languagesearch" title="API:Languagesearch"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Prefixsearch" title="Special:MyLanguage/API:Prefixsearch">Perform a prefix search for page titles</a><a href="/wiki/API:Prefixsearch" title="API:Prefixsearch"> </a></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Developer Utilities</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Client_code" title="Special:MyLanguage/API:Client code">Access libraries</a><a href="/wiki/API:Client_code" title="API:Client code"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Cross-site_requests" title="Special:MyLanguage/API:Cross-site requests">Cross-site requests</a><a href="/wiki/API:Cross-site_requests" title="API:Cross-site requests"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Extensions" title="Special:MyLanguage/API:Extensions">Creating an API module in an extension</a><a href="/wiki/API:Extensions" title="API:Extensions"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Calling_internally" title="Special:MyLanguage/API:Calling internally">Using the API in MediaWiki and extensions</a><a href="/wiki/API:Calling_internally" title="API:Calling internally"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Restricting_API_usage" title="Special:MyLanguage/API:Restricting API usage">Restricting API usage</a><a href="/wiki/API:Restricting_API_usage" title="API:Restricting API usage"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Localisation" title="Special:MyLanguage/API:Localisation">Localisation</a><a href="/wiki/API:Localisation" title="API:Localisation"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Implementation_Strategy" title="Special:MyLanguage/API:Implementation Strategy">Implementation Strategy</a><a href="/wiki/API:Implementation_Strategy" title="API:Implementation Strategy"> </a></li></ul></td> </tr><tr class="tpl-sidebar-heading"> <th class="" style="font-size: 16px; font-weight: 700; padding-top: 1em;;">Tutorials</th> </tr><tr class="tpl-sidebar-content"> <td class="" style=";"> <ul><li><a href="/wiki/Special:MyLanguage/API:Tutorial" title="Special:MyLanguage/API:Tutorial">Action API Tutorial</a><a href="/wiki/API:Tutorial" title="API:Tutorial"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Article_ideas_generator" title="Special:MyLanguage/API:Article ideas generator">Article ideas generator</a><a href="/wiki/API:Article_ideas_generator" title="API:Article ideas generator"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Nearby_places_viewer" title="Special:MyLanguage/API:Nearby places viewer">Nearby places viewer</a><a href="/wiki/API:Nearby_places_viewer" title="API:Nearby places viewer"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Picture_of_the_day_viewer" title="Special:MyLanguage/API:Picture of the day viewer">Picture of the day viewer</a><a href="/wiki/API:Picture_of_the_day_viewer" title="API:Picture of the day viewer"> </a></li> <li><a href="/wiki/Special:MyLanguage/API:Holidays_viewer" title="Special:MyLanguage/API:Holidays viewer">Holidays viewer</a><a href="/wiki/API:Holidays_viewer" title="API:Holidays viewer"> </a></li></ul></td> </tr><tr class="tpl-sidebar-navbar"> <td style=""><style data-mw-deduplicate="TemplateStyles:r4692751">.mw-parser-output .navbar{display:inline;font-size:88%;font-weight:normal}.mw-parser-output .navbar ul{display:inline;white-space:nowrap}.mw-parser-output .navbar li{word-spacing:-0.125em}.mw-parser-output .navbox .navbar{display:block;font-size:100%}.mw-parser-output .navbox-title .navbar{float:left;text-align:left;margin-right:0.5em;width:6em}</style><a href="/wiki/Template:API" title="Template:API">v</a> · <a class="external text" href="https://www.mediawiki.org/wiki/Template_talk:API">d</a> · <a class="external text" href="https://www.mediawiki.org/w/index.php?title=Template:API&action=edit">e</a></td> </tr> </tbody></table> <style data-mw-deduplicate="TemplateStyles:r4199130">.mw-parser-output .mw-version{border:1px solid #72777d;font-size:80%;line-height:1.2;border-collapse:collapse}.mw-parser-output .mw-version-ltr{float:right;margin:0 0 .5em .5em;text-align:right}.mw-parser-output .mw-version-rtl{float:left;margin:0 .5em .5em 0;text-align:left}.mw-parser-output .mw-version td{padding:.1em .3em}.mw-parser-output .mw-version-versionbox{border:5px solid #00af89;text-align:center}.mw-parser-output .mw-version-versionnumber{font-weight:bold;font-size:180%}.mw-parser-output .mw-version-version .mw-version-versionbox{border-color:#c8ccd1}.mw-parser-output .mw-version.mw-version-version2 .mw-version-versionbox{border-top-color:#c8ccd1;border-right-color:#c8ccd1;border-left-color:#c8ccd1}.mw-parser-output .mw-version-version-unsupported .mw-version-versionbox{border-color:#d33}.mw-parser-output .mw-version.mw-version-version2-unsupported .mw-version-versionbox{border-top-color:#d33;border-right-color:#d33;border-left-color:#d33}.mw-parser-output .mw-version-version-legacy .mw-version-versionbox{border-color:#f93}.mw-parser-output .mw-version.mw-version-version2-legacy .mw-version-versionbox{border-top-color:#f93;border-right-color:#f93;border-left-color:#f93}.mw-parser-output .mw-version-version-stable .mw-version-versionbox,.mw-parser-output .mw-version.mw-version.mw-version-and-later .mw-version-versionbox{border-color:#00af89}.mw-parser-output .mw-version.mw-version-version2-stable .mw-version-versionbox{border-top-color:#00af89;border-right-color:#00af89;border-left-color:#00af89}.mw-parser-output .mw-version-version-future .mw-version-versionbox{border-color:#8080c0}.mw-parser-output .mw-version.mw-version-version2-future .mw-version-versionbox{border-top-color:#8080c0;border-right-color:#8080c0;border-left-color:#8080c0}.mw-parser-output .mw-version-version-alpha .mw-version-versionbox{border-style:dotted}</style> <table class="mw-version mw-version-ltr mw-version-version mw-version-version-unsupported mw-version-and-later"><tbody><tr> <td>MediaWiki version:</td> <td class="mw-version-versionbox" title="The latest stable version is 1.42"><div class="mw-version-versionnumber">≥ 1.27</div></td> </tr></tbody></table> <style data-mw-deduplicate="TemplateStyles:r6651107">.mw-parser-output .note{background-position:left 7px top 50%;padding:0.5em 0.5em 0.5em 40px;margin:0.5em 0;overflow:hidden;background-color:#f8f9fa;color:#333;background-repeat:no-repeat;border:1px solid #ddd}.mw-parser-output .note-inline{display:inline-block;vertical-align:middle}.mw-parser-output .note-info{background-color:#eaf3ff;color:#333;background-image:url("https://upload.wikimedia.org/wikipedia/commons/e/ec/OOjs_UI_icon_information-progressive.svg");background-size:25px;border-color:#a3caff;padding-left:40px;min-height:25px}.mw-parser-output .note-reminder{background-color:#fff9ea;color:#333;background-image:url("https://upload.wikimedia.org/wikipedia/commons/a/a8/OOjs_UI_icon_lightbulb-yellow.svg");background-size:25px;border-color:#fc3;min-height:25px}.mw-parser-output .note-warn{background-color:#fff9ea;color:#333;background-image:url("https://upload.wikimedia.org/wikipedia/commons/3/3b/OOjs_UI_icon_alert-warning.svg");background-size:25px;border-color:#fc3;min-height:25px}.mw-parser-output .note-error{background-color:#fee7e6;color:#333;background-image:url("https://upload.wikimedia.org/wikipedia/commons/b/bf/OOjs_UI_icon_notice-destructive.svg");background-size:25px;border-color:#c33;min-height:25px}@media screen{html.skin-theme-clientpref-night .mw-parser-output .note{background-color:transparent;color:inherit}}@media screen and (prefers-color-scheme:dark){html.skin-theme-clientpref-os .mw-parser-output .note{background-color:transparent;color:inherit}}</style><div role="note" class="note note-info">This page documents the account creation API as of MediaWiki 1.27. Documentation of the API as it existed in earlier versions is available here: <a href="/wiki/Special:MyLanguage/Api:Account_creation/pre-1.27" title="Special:MyLanguage/Api:Account creation/pre-1.27">Api:Account creation/pre-1.27</a><a href="/wiki/API:Account_creation/pre-1.27" title="API:Account creation/pre-1.27"> </a>.</div> <meta property="mw:PageProp/toc" /> <div class="mw-heading mw-heading2"><h2 id="API_documentation">API documentation</h2>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=1" title="Edit section: API documentation">edit</a>]</div> <div style="color: var(--color-base, #202122); background-color: var(--background-color-interactive-subtle, #f8f9fa); padding: 20px; border: 1px solid var(--border-color-divider, #a2a9b1); overflow: hidden;"> <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r6651108"><table class="ombox ombox-notice plainlinks" role="presentation"><tbody><tr><td class="mbox-image"><a href="/wiki/File:Oxygen480-categories-preferences-system.svg" class="mw-file-description"><img src="//upload.wikimedia.org/wikipedia/commons/thumb/0/00/Oxygen480-categories-preferences-system.svg/20px-Oxygen480-categories-preferences-system.svg.png" decoding="async" width="20" height="20" class="mw-file-element" srcset="//upload.wikimedia.org/wikipedia/commons/thumb/0/00/Oxygen480-categories-preferences-system.svg/30px-Oxygen480-categories-preferences-system.svg.png 1.5x, //upload.wikimedia.org/wikipedia/commons/thumb/0/00/Oxygen480-categories-preferences-system.svg/40px-Oxygen480-categories-preferences-system.svg.png 2x" data-file-width="128" data-file-height="128" /></a></td><td class="mbox-text">The following documentation is the output of <a href="/wiki/Special:ApiHelp/createaccount" title="Special:ApiHelp/createaccount">Special:ApiHelp/createaccount</a>, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).</td></tr></tbody></table> <div style="word-wrap:break-word; overflow-wrap:break-word"><h2 class="apihelp-header apihelp-module-name" dir="ltr" lang="en" id="createaccount">action=createaccount (create)</h2><div class="apihelp-linktrail">(<a href="/wiki/Special:ApiHelp/main" class="apihelp-linktrail" dir="ltr" lang="en">main</a> | createaccount)</div> <div class="apihelp-block apihelp-flags"><ul><li>This module requires write rights.</li><li>This module only accepts POST requests.</li><li>Source: MediaWiki</li><li>License: <a href="/wiki/Special:Version/License/MediaWiki" title="Special:Version/License/MediaWiki">GPL-2.0-or-later</a></li></ul></div> Create a new user account. The general procedure to use this module is: <ol><li>Fetch the fields available from <kbd><a href="/w/api.php?action=help&modules=query%2Bauthmanagerinfo">action=query&meta=authmanagerinfo</a></kbd> with <kbd>amirequestsfor=create</kbd>, and a <kbd>createaccount</kbd> token from <kbd><a href="/w/api.php?action=help&modules=query%2Btokens">action=query&meta=tokens</a></kbd>.</li> <li>Present the fields to the user, and obtain their submission.</li> <li>Post to this module, supplying <var>createreturnurl</var> and any relevant fields.</li> <li>Check the <samp>status</samp> in the response. <ul><li>If you received <samp>PASS</samp> or <samp>FAIL</samp>, you're done. The operation either succeeded or it didn't.</li> <li>If you received <samp>UI</samp>, present the new fields to the user and obtain their submission. Then post to this module with <var>createcontinue</var> and the relevant fields set, and repeat step 4.</li> <li>If you received <samp>REDIRECT</samp>, direct the user to the <samp>redirecttarget</samp> and wait for the return to <var>createreturnurl</var>. Then post to this module with <var>createcontinue</var> and any fields passed to the return URL, and repeat step 4.</li> <li>If you received <samp>RESTART</samp>, that means the authentication worked but we don't have a linked user account. You might treat this as <samp>UI</samp> or as <samp>FAIL</samp>.</li></ul></li></ol> <div class="apihelp-block apihelp-help-urls"><ul><li><a href="https://www.mediawiki.org/wiki/Special:MyLanguage/API:Account_creation" dir="ltr">https://www.mediawiki.org/wiki/Special:MyLanguage/API:Account_creation</a></li></ul></div> <div class="apihelp-block apihelp-parameters"><div class="apihelp-block-head">Specific parameters:</div><div class="apihelp-block-header">Other general parameters are available.</div><dl><dt>createrequests</dt><dd class="description">Only use these authentication requests, by the <samp>id</samp> returned from <kbd><a href="/w/api.php?action=help&modules=query%2Bauthmanagerinfo">action=query&meta=authmanagerinfo</a></kbd> with <kbd>amirequestsfor=create</kbd> or from a previous response from this module. </dd><dd class="info">Separate values with <kbd>|</kbd> or <a href="/w/api.php?action=help&modules=main#main/datatypes">alternative</a>.</dd><dd class="info">Maximum number of values is 50 (500 for clients that are allowed higher limits).</dd><dt>createmessageformat</dt><dd class="description">Format to use for returning messages. </dd><dd class="info">One of the following values: html, none, raw, wikitext</dd><dd class="info">Default: wikitext</dd><dt>createmergerequestfields</dt><dd class="description">Merge field information for all authentication requests into one array. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>createpreservestate</dt><dd class="description">Preserve state from a previous failed login attempt, if possible. If <kbd><a href="/w/api.php?action=help&modules=query%2Bauthmanagerinfo">action=query&meta=authmanagerinfo</a></kbd> returned true for <samp>hasprimarypreservedstate</samp>, requests marked as <samp>primary-required</samp> should be omitted. If it returned a non-empty value for <samp>preservedusername</samp>, that username must be used for the <var>username</var> parameter. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>createreturnurl</dt><dd class="description">Return URL for third-party authentication flows, must be absolute. Either this or <var>createcontinue</var> is required. Upon receiving a <samp>REDIRECT</samp> response, you will typically open a browser or web view to the specified <samp>redirecttarget</samp> URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a <var>createcontinue</var> request to this API module. </dd><dt>createcontinue</dt><dd class="description">This request is a continuation after an earlier <samp>UI</samp> or <samp>REDIRECT</samp> response. Either this or <var>createreturnurl</var> is required. </dd><dd class="info">Type: boolean (<a href="/w/api.php?action=help&modules=main#main/datatype/boolean">details</a>)</dd><dt>createtoken</dt><dd class="description">A "createaccount" token retrieved from <a href="/w/api.php?action=help&modules=query%2Btokens">action=query&meta=tokens</a> </dd><dd class="info">This parameter is required.</dd><dt>*</dt><dd class="description">This module accepts additional parameters depending on the available authentication requests. Use <kbd><a href="/w/api.php?action=help&modules=query%2Bauthmanagerinfo">action=query&meta=authmanagerinfo</a></kbd> with <kbd>amirequestsfor=create</kbd> (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.</dd></dl></div> <div class="apihelp-block apihelp-examples"><div class="apihelp-block-head">Example:</div><dl><dt>Start the process of creating the user <kbd>Example</kbd> with the password <kbd>ExamplePassword</kbd>.</dt><dd><a href="/w/api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC" dir="ltr" rel="nofollow">api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC</a> <a href="/wiki/Special:ApiSandbox#action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC">[open in sandbox]</a></dd></dl></div> </div> </div> <div class="mw-heading mw-heading2"><h2 id="Creating_an_account">Creating an account</h2>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=2" title="Edit section: Creating an account">edit</a>]</div> The process has three general steps: <ol><li>Fetch the fields from <a href="/wiki/Special:MyLanguage/API:Authmanagerinfo" title="Special:MyLanguage/API:Authmanagerinfo">API:Authmanagerinfo</a><a href="/wiki/API:Authmanagerinfo" title="API:Authmanagerinfo"> </a> and the token from <a href="/wiki/Special:MyLanguage/API:Tokens" title="Special:MyLanguage/API:Tokens">API:Tokens</a><a href="/wiki/API:Tokens" title="API:Tokens"> </a>.</li> <li>Send a POST request with the fetched token, user information and other fields, and return URL to the API.</li> <li>Deal with the response, which might involve further POST requests to supply more information.</li></ol> <div class="mw-heading mw-heading3"><h3 id="Example_1:_Process_on_a_wiki_without_special_authentication_extensions">Example 1: Process on a wiki without special authentication extensions</h3>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=3" title="Edit section: Example 1: Process on a wiki without special authentication extensions">edit</a>]</div> A wiki without special authentication extensions can be rather straightforward. If your code knows which fields will be required, it might skip the call to <a href="/wiki/Special:MyLanguage/API:Authmanagerinfo" title="Special:MyLanguage/API:Authmanagerinfo">API:Authmanagerinfo</a><a href="/wiki/API:Authmanagerinfo" title="API:Authmanagerinfo"> </a> and just assume which fields will be needed (i.e. username, password & retyped password, email, possibly realname). <link rel="mw-deduplicated-inline-style" href="mw-data:TemplateStyles:r6651107"><div role="note" class="note note-info">If you are creating an account for someone else, you'll need to specify a reason for the same by including a <code>reason</code> parameter to the POST request. You could also use <code>mailpassword</code> in place of <code>password</code> and <code>retype</code> parameters to have MediaWiki send the new user a temporary password via email.</div> <div class="mw-heading mw-heading4"><h4 id="POST_request">POST request</h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=4" title="Edit section: POST request">edit</a>]</div> <div style="overflow:auto"> <div class="plainlinks" style="margin-bottom: 0.3em"><a class="external text" href="https://en.wikipedia.org/w/api.php?action=createaccount&createreturnurl=http://example.com/&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&username=zane&password=password&retype=password&email=zane@example.com&format=json">api.php?action=createaccount&createreturnurl=http://example.com/&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&username=zane&password=password&retype=password&email=zane@example.com&format=json</a> <a class="external text" href="https://en.wikipedia.org/wiki/Special:ApiSandbox#action=createaccount&createreturnurl=http://example.com/&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&username=zane&password=password&retype=password&email=zane@example.com&format=json">[try in ApiSandbox]</a></div> </div> <div class="mw-heading mw-heading4"><h4 id="Response">Response</h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=5" title="Edit section: Response">edit</a>]</div> <div class="mw-highlight mw-highlight-lang-json mw-content-ltr" dir="ltr"><pre>{ "createaccount": { "status": "PASS", "username": "Zane" } } </pre></div> <div class="mw-heading mw-heading4"><h4 id="Sample_code">Sample code</h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=6" title="Edit section: Sample code">edit</a>]</div> <div class="mw-gadget-tabbedwindow" style="width:100%"> <div class="mw-heading mw-heading3"><h3 id="Python">Python</h3>[<a href="/w/index.php?title=API:Account_creation/Sample_code_1&action=edit&section=T-1" title="Edit section: Python">edit</a>]</div> <div class="mw-highlight mw-highlight-lang-python mw-content-ltr" dir="ltr"><pre>#!/usr/bin/python3 """ create_account.py MediaWiki API Demos Demo of `createaccount` module: Create an account on a wiki without the special authentication extensions MIT license """ import requests S = requests.Session() WIKI_URL = "http://dev.wiki.local.wmftest.net:8080" API_ENDPOINT = WIKI_URL + "/w/api.php" # First step # Retrieve account creation token from `tokens` module PARAMS_0 = { 'action':"query", 'meta':"tokens", 'type':"createaccount", 'format':"json" } R = S.get(url=API_ENDPOINT, params=PARAMS_0) DATA = R.json() TOKEN = DATA['query']['tokens']['createaccounttoken'] # Second step # Send a post request with the fetched token and other data (user information, # return URL, etc.) to the API to create an account PARAMS_1 = { 'action': "createaccount", 'createtoken': TOKEN, 'username': 'your_username', 'password': 'your_password', 'retype': 'retype_your_password', 'createreturnurl': WIKI_URL, 'format': "json" } R = S.post(API_ENDPOINT, data=PARAMS_1) DATA = R.json() print(DATA) </pre></div> <div class="mw-heading mw-heading3"><h3 id="PHP">PHP</h3>[<a href="/w/index.php?title=API:Account_creation/Sample_code_1&action=edit&section=T-2" title="Edit section: PHP">edit</a>]</div> <div class="mw-highlight mw-highlight-lang-php mw-content-ltr" dir="ltr"><pre><?php /* create_account.php MediaWiki API Demos Demo of `createaccount` module: Create an account on a wiki without the special authentication extensions MIT license */ $wikiUrl = "http://dev.wiki.local.wmftest.net:8080"; $endPoint = $wikiUrl . "/w/api.php"; $createAccount_Token = getCreateAccountToken(); // Step 1 createAccount( $createAccount_Token ); // Step 2 // Step 1: GET request to fetch createaccount token function getCreateAccountToken() { global $endPoint; $params1 = [ "action" => "query", "meta" => "tokens", "type" => "createaccount", "format" => "json" ]; $url = $endPoint . "?" . http_build_query( $params1 ); $ch = curl_init( $url ); curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" ); curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" ); $output = curl_exec( $ch ); curl_close( $ch ); $result = json_decode( $output, true ); return $result["query"]["tokens"]["createaccounttoken"]; } // Step 2: POST request with the fetched token and other data (user information, // return URL, etc.) to the API to create an account function createAccount( $createAccount_Token ) { global $endPoint, $wikiUrl; $params2 = [ "action" => "createaccount", "createtoken" => $createAccount_Token, "username" => "your_username", "password" => "your_password", "retype" => "retype_your_password", "createreturnurl" => $wikiUrl, "format" => "json" ]; $ch = curl_init(); curl_setopt( $ch, CURLOPT_URL, $endPoint ); curl_setopt( $ch, CURLOPT_POST, true ); curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query( $params2 ) ); curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true ); curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" ); curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" ); $output = curl_exec( $ch ); curl_close( $ch ); echo( $output ); } </pre></div> <div class="mw-heading mw-heading3"><h3 id="JavaScript">JavaScript</h3>[<a href="/w/index.php?title=API:Account_creation/Sample_code_1&action=edit&section=T-3" title="Edit section: JavaScript">edit</a>]</div> <div class="mw-highlight mw-highlight-lang-javascript mw-content-ltr" dir="ltr"><pre>/* create_account.js MediaWiki API Demos Demo of `createaccount` module: Create an account on a wiki without the special authentication extensions MIT license */ var request = require('request').defaults({jar: true}), wikiUrl = "http://dev.wiki.local.wmftest.net:8080", endPoint = wikiUrl + "/w/api.php"; // Step 1: GET request to fetch createaccount token function getCreateAccountToken() { var params_0 = { action: "query", meta: "tokens", type: "createaccount", format: "json" }; request.get({ url: endPoint, qs: params_0 }, function (error, res, body) { if (error) { return; } var data = JSON.parse(body); createaccount(data.query.tokens.createaccounttoken); }); } // Step 2: POST request with the fetched token and other data (user information, // return URL, etc.) to the API to create an account function createaccount(createaccount_token) { var params_1 = { action: "createaccount", username: "your_username", password: "your_password", retype: "retype_your_password", createreturnurl: wikiUrl, createtoken: createaccount_token, format: "json" }; request.post({ url: endPoint, form: params_1 }, function (error, res, body) { if (error) { return; } console.log(body); }); } // Start From Step 1 getCreateAccountToken(); </pre></div> <div class="mw-heading mw-heading3"><h3 id="MediaWiki_JS">MediaWiki JS</h3>[<a href="/w/index.php?title=API:Account_creation/Sample_code_1&action=edit&section=T-4" title="Edit section: MediaWiki JS">edit</a>]</div> <div class="mw-highlight mw-highlight-lang-javascript mw-content-ltr" dir="ltr"><pre>/* create_account.js MediaWiki API Demos Demo of `createaccount` module: Create an account on a wiki without the special authentication extensions MIT License */ var params = { action: 'query', meta: 'tokens', type: 'createaccount', format: 'json' }, api = new mw.Api(); api.get( params ).done( function ( data ) { var token = data.query.tokens.createaccounttoken, params1 = { action: 'createaccount', username: 'your_username', password: 'your_password', retype: 'retype_your_password', createreturnurl: 'http:' + mw.config.get( 'wgServer' ), createtoken: token, format: 'json' }; api.post( params1 ).done( function ( data ) { console.log( data ); } ); } ); </pre></div> </div> <div class="mw-heading mw-heading3"><h3 id="Example_2:_Process_on_a_wiki_with_a_CAPTCHA_extension">Example 2: Process on a wiki with a CAPTCHA extension</h3>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=7" title="Edit section: Example 2: Process on a wiki with a CAPTCHA extension">edit</a>]</div> Note the first step below could, if you'd rather, be done as two steps: one to fetch the fields available from <a href="/wiki/Special:MyLanguage/API:Authmanagerinfo" title="Special:MyLanguage/API:Authmanagerinfo">API:Authmanagerinfo</a><a href="/wiki/API:Authmanagerinfo" title="API:Authmanagerinfo"> </a> and another to fetch the token from <a href="/wiki/Special:MyLanguage/API:Tokens" title="Special:MyLanguage/API:Tokens">API:Tokens</a><a href="/wiki/API:Tokens" title="API:Tokens"> </a>. <div class="mw-heading mw-heading4"><h4 id="First_step:_Fetch_fields_available_from_API:Authmanagerinfo_and_token_from_API:Tokens">First step: Fetch fields available from <a href="/wiki/Special:MyLanguage/API:Authmanagerinfo" title="Special:MyLanguage/API:Authmanagerinfo">API:Authmanagerinfo</a><a href="/wiki/API:Authmanagerinfo" title="API:Authmanagerinfo"> </a> and token from <a href="/wiki/Special:MyLanguage/API:Tokens" title="Special:MyLanguage/API:Tokens">API:Tokens</a><a href="/wiki/API:Tokens" title="API:Tokens"> </a></h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=8" title="Edit section: First step: Fetch fields available from API:Authmanagerinfo and token from API:Tokens">edit</a>]</div> <div class="plainlinks" style="margin-bottom: 0.3em"><a class="external text" href="https://en.wikipedia.org/w/api.php?action=query&meta=authmanagerinfo%7Ctokens&amirequestsfor=create&type=createaccount">api.php?action=query&meta=authmanagerinfo|tokens&amirequestsfor=create&type=createaccount</a> <a class="external text" href="https://en.wikipedia.org/wiki/Special:ApiSandbox#action=query&meta=authmanagerinfo%7Ctokens&amirequestsfor=create&type=createaccount">[try in ApiSandbox]</a></div><div style="display:block;margin-left:0;overflow:auto;"><table class="mw-collapsible mw-collapsed" style="margin-top:.2em; border:1px solid silver;text-align:left; width: 100%;"><tbody><tr><th style="font-size:112%;background:#F8FCFF;color:black;text-align:center">Result</th></tr><tr><td style="font-size:112%;background:white;border:solid 1px silver;padding:8px"><div><div class="mw-highlight mw-highlight-lang-javascript mw-content-ltr" dir="ltr"><pre>{ "batchcomplete": "", "query": { "authmanagerinfo": { "canauthenticatenow": "", "cancreateaccounts": "", "preservedusername": "", "requests": [ { "id": "CaptchaAuthenticationRequest", "metadata": { "type": "image", "mime": "image/png" }, "required": "required", "provider": "CaptchaAuthenticationRequest", "account": "CaptchaAuthenticationRequest", "fields": { "captchaId": { "type": "hidden", "value": "16649214", "label": "CAPTCHA ID", "help": "This value should be sent back unchanged." }, "captchaInfo": { "type": "null", "value": "/w/index.php?title=Special:Captcha/image&wpCaptchaId=16649214", "label": "To help protect against automated account creation, please enter the words that appear below in the box ([[Special:Captcha/help|more info]]):", "help": "Description of the CAPTCHA." }, "captchaWord": { "type": "string", "label": "CAPTCHA", "help": "Solution of the CAPTCHA." } } } ... ] }, "tokens": { "createaccounttoken": "1de8d3f8023305742e69db9e16b4d5365bd82f9c+\\" } } } </pre></div></div></td></tr></tbody></table></div> <div class="mw-heading mw-heading4"><h4 id="Second_step:_Send_a_post_request_along_with_a_create_account_token,_user_information_and_return_URL">Second step: Send a post request along with a create account token, user information and return URL</h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=9" title="Edit section: Second step: Send a post request along with a create account token, user information and return URL">edit</a>]</div> <div class="plainlinks" style="margin-bottom: 0.3em"><a class="external text" href="https://en.wikipedia.org/w/api.php?action=createaccount&createreturnurl=http://example.com/&createtoken=9ed1499d99c0c34c73faa07157b3b6075b427365+\&username=Amy&password=password&retype=password&email=amy@example.com&captchaId=70020580&captchaWord=winedtyping">api.php?action=createaccount&createreturnurl=http://example.com/&createtoken=9ed1499d99c0c34c73faa07157b3b6075b427365+\&username=Amy&password=password&retype=password&email=amy@example.com&captchaId=70020580&captchaWord=winedtyping</a> <a class="external text" href="https://en.wikipedia.org/wiki/Special:ApiSandbox#action=createaccount&createreturnurl=http://example.com/&createtoken=9ed1499d99c0c34c73faa07157b3b6075b427365+\&username=Amy&password=password&retype=password&email=amy@example.com&captchaId=70020580&captchaWord=winedtyping">[try in ApiSandbox]</a></div><div style="display:block;margin-left:0;overflow:auto;"><table class="mw-collapsible mw-collapsed" style="margin-top:.2em; border:1px solid silver;text-align:left; width: 100%;"><tbody><tr><th style="font-size:112%;background:#F8FCFF;color:black;text-align:center">Result</th></tr><tr><td style="font-size:112%;background:white;border:solid 1px silver;padding:8px"><div><div class="mw-highlight mw-highlight-lang-javascript mw-content-ltr" dir="ltr"><pre>{ "createaccount": { "status": "PASS", "username": "Zane" } } </pre></div></div></td></tr></tbody></table></div> <div class="mw-heading mw-heading4"><h4 id="Sample_Code_2">Sample Code</h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=10" title="Edit section: Sample Code">edit</a>]</div> Note this code sample separates the <a href="/wiki/Special:MyLanguage/API:Authmanagerinfo" title="Special:MyLanguage/API:Authmanagerinfo">API:Authmanagerinfo</a><a href="/wiki/API:Authmanagerinfo" title="API:Authmanagerinfo"> </a> and <a href="/wiki/Special:MyLanguage/API:Tokens" title="Special:MyLanguage/API:Tokens">API:Tokens</a><a href="/wiki/API:Tokens" title="API:Tokens"> </a> requests, and generally assumes there will be a CAPTCHA and no other complications. <div style="display:block;margin-left:0;"><table class="mw-collapsible mw-collapsed" style="margin-top:.2em; border:1px solid silver;text-align:left; width: 100%;"><tbody><tr><th style="font-size:112%;background:#F8FCFF;color:black;text-align:center">create_account_with_captcha.py</th></tr><tr><td style="font-size:112%;background:white;border:solid 1px silver;padding:8px"> <div class="mw-highlight mw-highlight-lang-python3 mw-content-ltr" dir="ltr"><pre>#!/usr/bin/python3 """ create_account_with_captcha.py MediaWiki Action API Code Samples Demo of `createaccount` module: Create an account on a wiki with a special authentication extension installed. This example considers a case of a wiki where captcha is enabled through extensions like ConfirmEdit (https://www.mediawiki.org/wiki/Extension:ConfirmEdit) MIT license """ import requests from flask import Flask, render_template, flash, request S = requests.Session() WIKI_URL = "https://test.wikipedia.org" API_ENDPOINT = WIKI_URL + "/w/api.php" # App config. DEBUG = True APP = Flask(__name__) APP.config.from_object(__name__) APP.config['SECRET_KEY'] = 'enter_your_secret_key' @APP.route("/", methods=['GET', 'POST']) def show_form(): """ Render form template and handle form submission request """ fields = get_form_fields() captcha = fields['CaptchaAuthenticationRequest'] captcha_url = WIKI_URL + captcha['captchaInfo']['value'] captcha_id = captcha['captchaId']['value'] display_fields = [] user_fields = [] captcha_fields = [] for field in fields: for name in fields[field]: details = { 'name': name, 'type': fields[field][name]['type'], 'label': fields[field][name]['label'] } if field != "CaptchaAuthenticationRequest": user_fields.append(details) else: if name == 'captchaWord': captcha_fields.append(details) display_fields = user_fields + captcha_fields if request.method == 'POST': create_account(request.form, captcha_id) return render_template('create_account_form.html', \ captcha=captcha_url, fields=display_fields) def get_form_fields(): """ Fetch the form fields from `authmanagerinfo` module """ result = {} response = S.get(url=API_ENDPOINT, params={ 'action': 'query', 'meta': 'authmanagerinfo', 'amirequestsfor': 'create', 'format': 'json' }) data = response.json() query = data and data['query'] authmanagerinfo = query and query['authmanagerinfo'] fields = authmanagerinfo and authmanagerinfo['requests'] for field in fields: if field['id'] in ('MediaWiki\\Auth\\UserDataAuthenticationRequest', \ 'CaptchaAuthenticationRequest', 'MediaWiki\\Auth\\PasswordAuthenticationRequest'): result[field['id']] = field['fields'] return result def create_account(form, captcha_id): """ Send a post request along with create account token, user information and return URL to the API to create an account on a wiki """ createtoken = fetch_create_token() response = S.post(url=API_ENDPOINT, data={ 'action': 'createaccount', 'createtoken': createtoken, 'username': form['username'], 'password': form['password'], 'retype': form['retype'], 'email': form['email'], 'createreturnurl': 'http://127.0.0.1:5000/', 'captchaId': captcha_id, 'captchaWord': form['captchaWord'], 'format': 'json' }) data = response.json() createaccount = data['createaccount'] if createaccount['status'] == "PASS": flash('Success! An account with username ' + \ form['username'] + ' has been created!') else: flash('Oops! Something went wrong -- ' + \ createaccount['messagecode'] + "." + createaccount['message']) def fetch_create_token(): """ Fetch create account token via `tokens` module """ response = S.get(url=API_ENDPOINT, params={ 'action': 'query', 'meta': 'tokens', 'type': 'createaccount', 'format': 'json' }) data = response.json() return data['query']['tokens']['createaccounttoken'] if __name__ == "__main__": APP.run() </pre></div> </td></tr></tbody></table></div> <div style="display:block;margin-left:0;"><table class="mw-collapsible mw-collapsed" style="margin-top:.2em; border:1px solid silver;text-align:left; width: 100%;"><tbody><tr><th style="font-size:112%;background:#F8FCFF;color:black;text-align:center">create_account_form.html</th></tr><tr><td style="font-size:112%;background:white;border:solid 1px silver;padding:8px"> <div class="mw-highlight mw-highlight-lang-html mw-content-ltr" dir="ltr"><pre><!DOCTYPE html> <title>MediaWiki Create Account</title>  <link rel="stylesheet" href="static/bootstrap/css/bootstrap.min.css"> <link rel="stylesheet" href="static/css/account_form.css"> <div class="container"> <h2>Create MediaWiki Account</h2> <form method="POST"> <div class="form-group"> <div class="form-field"> <div class="label-field">Enter your username</div> <input name="username"> </div> <div class="form-field"> <div class="label-field">Password</div> <input type="password" name="password"> </div> <div class="form-field"> <div class="label-field">Confirm password</div> <input type="password" name="confirm-password"> </div> <div class="form-field"> <div class="label-field">Enter address (optional)</div> <input name="email"> </div> <div class="form-field"> <div class="label-field">Enter the text you see on the image below</div> <input name="captcha-word"> </div> <img src="{{ captcha }}"> </div> <button type="submit" class="btn btn-success">Create your account</button> </form> <br> {% with messages = get_flashed_messages(with_categories=true) %} {% if messages %} {% for message in messages %} <div class="alert alert-info"> {{ message[1] }} </div> {% endfor %} {% endif %} {% endwith %} </div> <br> </div> </div> </pre></div> </td></tr></tbody></table></div> <div class="mw-heading mw-heading3"><h3 id="Example_3:_Account_creation_on_a_wiki_with_a_CAPTCHA,_an_OpenID_extension,_and_a_two-factor_authentication_extension_enabled">Example 3: Account creation on a wiki with a CAPTCHA, an OpenID extension, and a two-factor authentication extension enabled</h3>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=11" title="Edit section: Example 3: Account creation on a wiki with a CAPTCHA, an OpenID extension, and a two-factor authentication extension enabled">edit</a>]</div> <div class="mw-heading mw-heading4"><h4 id="First_step:_Fetch_fields_available_from_API:Authmanagerinfo_and_token_from_API:Tokens_2">First step: Fetch fields available from <a href="/wiki/Special:MyLanguage/API:Authmanagerinfo" title="Special:MyLanguage/API:Authmanagerinfo">API:Authmanagerinfo</a><a href="/wiki/API:Authmanagerinfo" title="API:Authmanagerinfo"> </a> and token from <a href="/wiki/Special:MyLanguage/API:Tokens" title="Special:MyLanguage/API:Tokens">API:Tokens</a><a href="/wiki/API:Tokens" title="API:Tokens"> </a></h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=12" title="Edit section: First step: Fetch fields available from API:Authmanagerinfo and token from API:Tokens">edit</a>]</div> The fetching of <a href="/wiki/Special:MyLanguage/API:Authmanagerinfo" title="Special:MyLanguage/API:Authmanagerinfo">API:Authmanagerinfo</a><a href="/wiki/API:Authmanagerinfo" title="API:Authmanagerinfo"> </a> and <a href="/wiki/Special:MyLanguage/API:Tokens" title="Special:MyLanguage/API:Tokens">API:Tokens</a><a href="/wiki/API:Tokens" title="API:Tokens"> </a> is largely the same as in the previous example, and so is not repeated here. The list of requests returned by <a href="/wiki/Special:MyLanguage/API:Authmanagerinfo" title="Special:MyLanguage/API:Authmanagerinfo">API:Authmanagerinfo</a><a href="/wiki/API:Authmanagerinfo" title="API:Authmanagerinfo"> </a> will include definitions for both the CAPTCHA extension and the OpenID extension. <div class="mw-heading mw-heading4"><h4 id="Second_step:_Answer_the_CAPTCHA_and_select_OpenID_authentication.">Second step: Answer the CAPTCHA and select OpenID authentication.</h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=13" title="Edit section: Second step: Answer the CAPTCHA and select OpenID authentication.">edit</a>]</div> <div style="overflow:auto"> <div class="plainlinks" style="margin-bottom: 0.3em"><a class="external text" href="https://en.wikipedia.org/w/api.php?action=createaccount&createreturnurl=http://example.com/authenticating.php&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&captchaId=12345&captchaWord=MediaWikiIsCool&username=Alice&openIdProvider=openid.example.net&useOpenId=1">api.php?action=createaccount&createreturnurl=http://example.com/authenticating.php&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&captchaId=12345&captchaWord=MediaWikiIsCool&username=Alice&openIdProvider=openid.example.net&useOpenId=1</a> <a class="external text" href="https://en.wikipedia.org/wiki/Special:ApiSandbox#action=createaccount&createreturnurl=http://example.com/authenticating.php&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&captchaId=12345&captchaWord=MediaWikiIsCool&username=Alice&openIdProvider=openid.example.net&useOpenId=1">[try in ApiSandbox]</a></div><div style="display:block;margin-left:0;overflow:auto;"><table class="mw-collapsible mw-collapsed" style="margin-top:.2em; border:1px solid silver;text-align:left; width: 100%;"><tbody><tr><th style="font-size:112%;background:#F8FCFF;color:black;text-align:center">Result</th></tr><tr><td style="font-size:112%;background:white;border:solid 1px silver;padding:8px"><div><div class="mw-highlight mw-highlight-lang-javascript mw-content-ltr" dir="ltr"><pre>{ "createaccount": { "status": "REDIRECT", "redirecttarget": "https://openid.example.net/openid-auth.php?scope=openid&response_type=code&client_id=ABC&redirect_uri=https://wiki.example.org/wiki/Special:OpenIDConnectReturn&state=XYZ123", "requests": [ { "id": "OpenIdConnectResponseAuthenticationRequest", "metadata": {}, "required": "required", "provider": "OpenID Connect at example.net", "account": "", "fields": { "code": { "type": "string", "label": "OpenID Code", "help": "OpenID Connect code response" }, "state": { "type": "string", "label": "OpenID State", "help": "OpenID Connect state response" }, } } ] } } </pre></div></div></td></tr></tbody></table></div> </div> The client would be expected to redirect the user's browser to the provided <var>redirecttarget</var>. The OpenID provider would authenticate, and redirect to Special:OpenIDConnectReturn on the wiki, which would validate the OpenID response and then redirect to the <var>createreturnurl</var> provided in the first POST to the API with the <var>code</var> and <var>state</var> parameters added. The client gets control of the process back at this point and makes its next API request. <div class="mw-heading mw-heading4"><h4 id="Third_step:_Back_from_OpenID.">Third step: Back from OpenID.</h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=14" title="Edit section: Third step: Back from OpenID.">edit</a>]</div> The client posts the <var>code</var> and <var>state</var> back to the API. The API's response has the two-factor authentication extension prompting the user to set up their second factor. <div style="overflow:auto"> <div class="plainlinks" style="margin-bottom: 0.3em"><a class="external text" href="https://en.wikipedia.org/w/api.php?action=createaccount&createcontinue=1&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&code=SplxlOBeZQQYbYS6WxSbIA&state=XYZ123">api.php?action=createaccount&createcontinue=1&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&code=SplxlOBeZQQYbYS6WxSbIA&state=XYZ123</a> <a class="external text" href="https://en.wikipedia.org/wiki/Special:ApiSandbox#action=createaccount&createcontinue=1&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&code=SplxlOBeZQQYbYS6WxSbIA&state=XYZ123">[try in ApiSandbox]</a></div><div style="display:block;margin-left:0;overflow:auto;"><table class="mw-collapsible mw-collapsed" style="margin-top:.2em; border:1px solid silver;text-align:left; width: 100%;"><tbody><tr><th style="font-size:112%;background:#F8FCFF;color:black;text-align:center">Result</th></tr><tr><td style="font-size:112%;background:white;border:solid 1px silver;padding:8px"><div><div class="mw-highlight mw-highlight-lang-javascript mw-content-ltr" dir="ltr"><pre>{ "createaccount": { "status": "UI", "message": "Set up two-factor authentication", "requests": [ { "id": "TwoFactorAuthenticationRequest", "metadata": { "account": "Alice", "secret": "6CO3 2AKV EP2X MIV5" }, "required": "optional", "provider": "", "account": "", "fields": { "2FAInfo": { "type": "null", "label": "A bunch of text describing how to set up two-factor auth.", "help": "Two-factor authentication setup instructions" }, "code": { "type": "string", "label": "Code", "help": "Two-factor authentication code" } } }, { "id": "MediaWiki\\Auth\\ButtonAuthenticationRequest:skip2FASetup", "metadata": {}, "required": "optional", "provider": "MediaWiki\\Auth\\ButtonAuthenticationRequest", "account": "MediaWiki\\Auth\\ButtonAuthenticationRequest:skip2FASetup", "fields": { "skip2FASetup": { "type": "button", "label": "Skip", "help": "Skip two-factor authentication setup" } } } ] } } </pre></div></div></td></tr></tbody></table></div> </div> Now the client would prompt the user to set up a new account in their two-factor authentication app and enter the current code, or allow the user to skip 2FA setup. Let's assume the user does set up 2FA. <div class="mw-heading mw-heading4"><h4 id="Fourth_step:_Set_up_two-factor_authentication.">Fourth step: Set up two-factor authentication.</h4>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=15" title="Edit section: Fourth step: Set up two-factor authentication.">edit</a>]</div> <div style="overflow:auto"> <div class="plainlinks" style="margin-bottom: 0.3em"><a class="external text" href="https://en.wikipedia.org/w/api.php?action=createaccount&createcontinue=1&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&code=817420">api.php?action=createaccount&createcontinue=1&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&code=817420</a> <a class="external text" href="https://en.wikipedia.org/wiki/Special:ApiSandbox#action=createaccount&createcontinue=1&createtoken=29590a3037d325be70b93fb8258ed29257448cfb%2B%5C&code=817420">[try in ApiSandbox]</a></div><div style="display:block;margin-left:0;overflow:auto;"><table class="mw-collapsible mw-collapsed" style="margin-top:.2em; border:1px solid silver;text-align:left; width: 100%;"><tbody><tr><th style="font-size:112%;background:#F8FCFF;color:black;text-align:center">Result</th></tr><tr><td style="font-size:112%;background:white;border:solid 1px silver;padding:8px"><div><div class="mw-highlight mw-highlight-lang-javascript mw-content-ltr" dir="ltr"><pre>{ "createaccount": { "status": "PASS", "username": "Alice" } } </pre></div></div></td></tr></tbody></table></div> </div> The account creation has finally succeeded. If at any point account creation fails, a response with status <samp>FAIL</samp> will be returned, along with a <samp>message</samp> to display to the user. <div class="mw-heading mw-heading2"><h2 id="Possible_errors">Possible errors</h2>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=16" title="Edit section: Possible errors">edit</a>]</div> <table class="wikitable"> <caption> </caption> <tbody><tr> <th>Code </th> <th>Info </th></tr> <tr> <td>badtoken </td> <td>Invalid create account token </td></tr> <tr> <td>notoken </td> <td>The <var>token</var> parameter must be set. </td></tr> <tr> <td>mustpostparams </td> <td>The following parameter was found in the query string, but must be in the POST body: createtoken. </td></tr> <tr> <td>missingparam </td> <td>At least one of the parameters "createcontinue" and "createreturnurl" is required. </td></tr> <tr> <td>authmanager-create-no-primary </td> <td>The supplied credentials could not be used for account creation. </td></tr> <tr> <td>noemailcreate </td> <td>You need to provide a valid email address. </td></tr> <tr> <td>invalidemailaddress </td> <td>The email address cannot be accepted as it appears to have an invalid format. Please enter a well-formatted address or empty that field. </td></tr> <tr> <td>badretype </td> <td>The passwords you entered do not match. </td></tr> <tr> <td>userexists </td> <td>Username entered already in use. Please choose a different name. </td></tr> <tr> <td>captcha-createaccount-fail </td> <td>Incorrect or missing CAPTCHA. </td></tr> <tr> <td>acct_creation_throttle_hit </td> <td>Visitors to this wiki using your IP address have created num accounts in the last day, which is the maximum allowed in this time period. As a result, visitors using this IP address cannot create any more accounts at the moment. If you are at an event where contributing to Wikimedia projects is the focus, please see <a href="https://meta.wikimedia.org/wiki/Mass_account_creation#Requesting_temporary_lift_of_IP_cap" class="extiw" title="m:Mass account creation">Requesting temporary lift of IP cap</a> to help resolve this issue. </td></tr></tbody></table> <div class="mw-heading mw-heading2"><h2 id="Additional_notes">Additional notes</h2>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=17" title="Edit section: Additional notes">edit</a>]</div> <ul><li>Account creations are recorded in <a href="/wiki/Special:Log/newusers" title="Special:Log/newusers">Special:log/newusers</a>.</li></ul> If you are logged in, your username will also be recorded when creating an account. <ul><li>While executing the code snippets provided on this page, remember: <ul><li>Once an account on a wiki is created, it cannot be deleted.</li> <li>Always use <a class="external text" href="https://test.wikipedia.org"><code>https://test.wikipedia.org/w/api.php</code></a> as the endpoint, so that you don't accidentally create accounts on production wikis.</li></ul></li> <li>MediaWiki site administrators and extension developers can disable this API feature by inserting the following line in the configuration file:</li></ul> <div class="mw-highlight mw-highlight-lang-php mw-content-ltr" dir="ltr"><pre>$wgAPIModules['createaccount'] = 'ApiDisabled'; </pre></div> <div class="mw-heading mw-heading2"><h2 id="See_also">See also</h2>[<a href="/w/index.php?title=API:Account_creation&action=edit&section=18" title="Edit section: See also">edit</a>]</div> <ul><li><a href="/wiki/Special:MyLanguage/API:Restricting_API_usage" title="Special:MyLanguage/API:Restricting API usage">How to restrict API usage</a><a href="/wiki/API:Restricting_API_usage" title="API:Restricting API usage"> </a></li></ul>    </div><noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?type=1x1" alt="" width="1" height="1" style="border: none; position: absolute;"></noscript> <div class="printfooter" data-nosnippet="">Retrieved from "<a dir="ltr" href="https://www.mediawiki.org/w/index.php?title=API:Account_creation&oldid=6728511">https://www.mediawiki.org/w/index.php?title=API:Account_creation&oldid=6728511</a>"</div></div> <div id="catlinks" class="catlinks" data-mw="interface"><div id="mw-normal-catlinks" class="mw-normal-catlinks"><a href="/wiki/Special:Categories" title="Special:Categories">Category</a>: <ul><li><a href="/wiki/Category:MediaWiki_action_API" title="Category:MediaWiki action API">MediaWiki action API</a></li></ul></div></div> </div> </main> </div> <div class="mw-footer-container"> <footer id="footer" class="mw-footer" > <ul id="footer-info"> <li id="footer-info-lastmod"> This page was last edited on 29 August 2024, at 17:35.</li> <li id="footer-info-copyright">Text is available under the <a rel="nofollow" class="external text" href="https://creativecommons.org/licenses/by-sa/4.0/deed.en">Creative Commons Attribution-ShareAlike License</a>; additional terms may apply. Text in <a class="external text" href="https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents">the Help: namespace</a> is available under the <a rel="nofollow" class="external text" href="https://creativecommons.org/publicdomain/zero/1.0/">Creative Commons CC0 License</a>. By using this site, you agree to the <a class="external text" href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Terms_of_Use">Terms of Use</a> and <a class="external text" href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy">Privacy Policy</a>.</li> </ul> <ul id="footer-places"> <li id="footer-places-privacy"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Privacy_policy">Privacy policy</a></li> <li id="footer-places-about"><a href="/wiki/Project:About">About mediawiki.org</a></li> <li id="footer-places-disclaimers"><a href="/wiki/Project:General_disclaimer">Disclaimers</a></li> <li id="footer-places-wm-codeofconduct"><a href="https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct">Code of Conduct</a></li> <li id="footer-places-developers"><a href="https://developer.wikimedia.org">Developers</a></li> <li id="footer-places-statslink"><a href="https://stats.wikimedia.org/#/www.mediawiki.org">Statistics</a></li> <li id="footer-places-cookiestatement"><a href="https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Cookie_statement">Cookie statement</a></li> <li id="footer-places-mobileview"><a href="//m.mediawiki.org/w/index.php?title=API:Account_creation&mobileaction=toggle_view_mobile" class="noprint stopMobileRedirectToggle">Mobile view</a></li> </ul> <ul id="footer-icons" class="noprint"> <li id="footer-copyrightico"><a href="https://wikimediafoundation.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/static/images/footer/wikimedia-button.svg" width="84" height="29" alt="Wikimedia Foundation" loading="lazy"></a></li> <li id="footer-poweredbyico"><a href="https://www.mediawiki.org/" class="cdx-button cdx-button--fake-button cdx-button--size-large cdx-button--fake-button--enabled"><img src="/w/resources/assets/poweredby_mediawiki.svg" alt="Powered by MediaWiki" width="88" height="31" loading="lazy"></a></li> </ul> </footer> </div> </div> </div> <div class="vector-settings" id="p-dock-bottom"> <ul></ul> </div><script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgHostname":"mw-web.codfw.canary-74567ccdbd-g8bvg","wgBackendResponseTime":952,"wgPageParseReport":{"limitreport":{"cputime":"0.621","walltime":"0.834","ppvisitednodes":{"value":6677,"limit":1000000},"postexpandincludesize":{"value":83287,"limit":2097152},"templateargumentsize":{"value":33405,"limit":2097152},"expansiondepth":{"value":15,"limit":100},"expensivefunctioncount":{"value":34,"limit":500},"unstrip-depth":{"value":0,"limit":20},"unstrip-size":{"value":93414,"limit":5000000},"entityaccesscount":{"value":0,"limit":400},"timingprofile":["100.00% 448.579 1 -total"," 47.70% 213.971 1 Template:API"," 41.21% 184.878 66 Template:Ll"," 38.06% 170.716 1 Template:Sidebar"," 25.30% 113.500 133 Template:Translatable"," 24.40% 109.468 82 Template:Pagelang"," 13.39% 60.076 1 Template:Api_help"," 11.57% 51.911 1 Special:ApiHelp/createaccount"," 8.42% 37.786 1 Template:Mbox"," 7.34% 32.948 6 Template:ApiEx"]},"scribunto":{"limitreport-timeusage":{"value":"0.116","limit":"10.000"},"limitreport-memusage":{"value":1544129,"limit":52428800}},"cachereport":{"origin":"mw-web.codfw.canary-74567ccdbd-g8bvg","timestamp":"20241127093327","ttl":2947,"transientcontent":true}}});});</script> </body> </html>