API:Account creation/pre-1.27/ja

MediaWiki バージョン:

≥ 1.21

アカウント作成

APIを使ってアカウントを作成することができます。あなた自身のために新しいアカウントを作成することもできますし、他の誰かのためにランダムなパスワードを本人にメールで送信して作成することもできます。アカウントの作成はSpecial:log/newusersに記録されます。もしログインしていれば、あなたの利用者名もアカウントを作成するときに記録されます。

パラメーター

• name: 利用者名
• password: パスワード (ignored if mailpassword is set)
• domain: Domain for external authentication (optional)
• token: Account creation token obtained in first request
• email: Email address of user (Optional unless mailpassword is set)
• realname: Real name of user (Optional. Additionally many wikis have realname disabled via $wgHiddenPrefs)

  Note: To check whether realname is enabled or not, request api.php?action=query&meta=userinfo&uiprop=realname. If you get no realname property back in the response, realname is a hidden preference.

• mailpassword: If set to any value, a random password will be generated and e-mailed to the user (instead of using the password parameter)
• reason: Optional reason for creating the account. Will be shown in the account creation log (example).
• language: Language code to set as default for the user

Extended parameters when used with Extension:ConfirmEdit:

• captchaid: Previously-provided CAPTCHA ID to send with followup request, if captcha was required
• captchaword: User-provided answer of CAPTCHA to send with followup request, if captcha was required

トークン

アカウントを作成するにはトークンが必要です。トークンを取得するには、トークンの部分を未入力にしてリクエストを送信します。トークンを取得したら、もう一度トークンを入力してそのリクエストを送信します。これはログインモジュールの使い方と似ています。詳細は以下の例をご覧ください。

多くのAPIのトークンと異なり、アカウント作成のためのトークンは一度だけしか使用できません。このモジュールでひとつアカウントを作成すると、他のアカウントを作成するには新しいトークンが必要です。(成功したときのメッセージにそのようなトークンが含まれます。)

例

注記: 簡潔性のためにこの例ではすべてのパラメーターをGETリクエストで渡していますが, action=createaccount はPOSTリクエストを必要とします; GETリクエストだとエラーが発生します。

Step 1: Retrieve token to create an account for GymBeauWhales

api.php?action=createaccount&name=GymBeauWhales&email=GymBeauWhales@wikipmediawiki.net&realname=Gymmy_Dahnyl_Wails&mailpassword=true&reason=Fun_and_profit&language=en&token= [ApiSandbox で試用する]

We should now receive a response like:

<?xml version="1.0"?>
<api>
 <createaccount token="387bc54bd0ec29333178800ce4213306" result="needtoken" />
</api>

If you get an error about "newcookiesfornew", it is due to a bug in early versions of 1.21. Repeating the request should fix that

We take the token given here, and add it to the request:

Step 2: Actually create GymBeauWhales account

api.php?action=createaccount&name=GymBeauWhales&email=GymBeauWhales@wikipmediawiki.net&realname=Gymmy_Dahnyl_Wails&mailpassword=true&reason=Fun_and_profit&language=en&token=387bc54bd0ec29333178800ce4213306 [ApiSandbox で試用する]

Assuming everything works, we should get a result like:

<?xml version="1.0"?>
<api>
 <createaccount token="387bc54bd0ec29333178800ce4213306" userid="1234" username="GymBeauWhales" result="success" />
</api>

And GymBeauWhales@wikipmediawiki.net would get an email with instructions on how to log in.

CAPTCHA

When used with Extension:ConfirmEdit, a CAPTCHA may be presented for new account creations. This is supported via extension in the API here.

When submitting per the above rules and receiving a response, you may also receive a captcha node in the return data, similar to what is sometimes returned by action=edit.

For a text-based CAPTCHA:

{
  "createaccount": {
    "result": "NeedCaptcha",
    "captcha": {
      "type": "simple",
      "mime": "text/plain",
      "id": "323035635",
      "question": "77+5"
    }
  }
}

For an image-based CAPTCHA:

{
  "createaccount": {
    "result": "NeedCaptcha",
    "captcha": {
      "type": "image",
      "mime": "image/png",
      "id": "1147869849",
      "url": "/core/index.php?title=Special:Captcha/image&wpCaptchaId=1147869849"
    }
  }
}

Be aware that the URL may be site-relative or protocol-relative.

As of the current code (see [1]) you won't receive the captcha prompt response until after basic validation errors have been taken care of.

起こりうる出力

The result attribute can have one of three values:

• needtoken: A token is needed. A token parameter should also be set with a token to use.

  <?xml version="1.0"?><api><createaccount token="8217b293a6bd0bba84cc1cb661a06a5d" result="needtoken" /></api>
  

  • If you get a needtoken result when you are expecting a success result, make sure the token you are sending is correct, and that you are sending along any cookies sent by the API.
• success: Everything worked

  <syntaxhighlightlang="xml"><?xml version="1.0"?><api><createaccount token="387bc54bd0ec29333178800ce4213306" userid="1234" username="foo" result="success" /></api></syntaxhighlight>

• warning: Not used in core, however extensions can (in theory) add warnings, in which case the result attribute will be warning. However, this still generally means the account was created successfully.

起こりうるエラー

All errors are formatted as:

<error code="code" info="info">

Many of the info codes to this module correspond to system messages. As a result the info part may change and in particular will vary with language.

コード	情報
nocookiesfornew	The user account was not created, as we could not confirm its source. Ensure you have cookies enabled, reload this page and try again. Note: This code is sometimes returned due to a bug in early versions of MediaWiki 1.21. If you receive this error, retrying the request (ensuring cookies are sent) should fix.
sorbs_create_account_reason	Your IP address is listed as an open proxy in the DNSBL.
noname	You have not specified a valid username
userexists	Username entered already in use
password-name-match	Your password must be different from your username.
password-login-forbidden	The use of this username and password has been forbidden
noemailtitle	No email address
invalidemailaddress	The e-mail address cannot be accepted as it appears to have an invalid format
externaldberror	There was either an authentication database error or you are not allowed to update your external account
passwordtooshort	The password was shorter than the value of $wgMinimalPasswordLength
noemail	There is no e-mail address recorded for user
mustbeposted	The createaccount module requires a POST request
acct_creation_throttle_hit	Visitors to this wiki using your IP address have created $1 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.
wrongpassword	Incorrect password entered. Please try again. Note: Can be caused by the "domain" field being incorrect.
aborted	Aborted by an extension (info will have more details)
blocked	You cannot create a new account because you are blocked
permdenied-createaccount	You do not have the right to create a new account
createaccount-hook-aborted	An extension aborted the account creation
captcha-createaccount-fail	(With Extension:ConfirmEdit and old core) Submitted CAPTCHA answer was incorrect

無効化

このAPIの機能を無効化するには、以下の行を設定ファイルに追加します:

$wgAPIModules['createaccount'] = 'ApiDisabled';

関連項目

• How to restrict API usage
• Enable/Disable (write) API
• Extension:SignupAPI/ja from 2011: in order to implement a Special:UserSignup form with an AJAX-y interactive validation, this extension also implements action=signup and action=validatesignup APIs.