For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/zh/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/zh/llms-full.txt, and this page is available as Markdown at https://types-mediawiki-response.pages.dev/zh/api/extensions/centralauth/overview.md.
  • 中文
  • CentralAuth

    Interfaces

    InterfaceDescription
    ApiCentralAuthInBandErrorResponseIn-band failure of action=deleteglobalaccount / action=createlocalaccount: the messages appear under the root error key as a list of per-status lists — not as a standard ApiErrorResponse — so error carries no code/info of its own.
    ApiCentralAuthTokenResponseResponse of action=centralauthtoken: a token that authenticates the current CentralAuth session on another wiki of the farm (sent as the centralauthtoken parameter there). Requires a logged-in user attached to a global account whose session comes from the CentralAuth session provider; every other case is a standard top-level error (notloggedin, badsession, notattached).
    ApiCreateLocalAccountResponseResponse of action=createlocalaccount. Unlike setglobalaccountstatus, a failure returns only the root error list and no result object.
    ApiCreateLocalAccountResultResult of action=createlocalaccount (CSRF-token POST, centralauth-createlocal right): a local account was force-created on this wiki for the global account.
    ApiDeleteGlobalAccountResponseResponse of action=deleteglobalaccount.
    ApiDeleteGlobalAccountResultResult of action=deleteglobalaccount (its own token type POST): the global account was unmerged (deleted).
    ApiGlobalCentralUserOne list=globalallusers entry. aguprop controls which fields beyond ApiGlobalCentralUser.id / ApiGlobalCentralUser.name appear. Hidden accounts (suppressed from public lists) never appear here at all.
    ApiGlobalGroupOne list=globalgroups entry: a global group defined on the wiki farm. The rows derive from the global_group_permissions table, so groups are only listed once they have at least one permission granted.
    ApiGlobalGroupMembershipOne global group membership of a list=globalusers row.
    ApiGlobalUserFoundOne list=globalusers entry for an existing global account. gusprop controls which fields beyond ApiGlobalUserFound.centralid / ApiGlobalUserFound.name appear. Results come back in request order; unknown names/ids get marker rows (see ApiGlobalUserRow).
    ApiGlobalUserInvalidNameA list=globalusers row for a requested name that is not a valid username.
    ApiGlobalUserLocalInfoThe localinfo object of a list=globalusers row.
    ApiGlobalUserMissingIdA list=globalusers row for a requested global id with no global account.
    ApiGlobalUserMissingNameA list=globalusers row for a requested name with no global account.
    ApiGlobalUserRightsResponseResponse of action=globaluserrights. Failures are standard top-level errors.
    ApiGlobalUserRightsResultResult of action=globaluserrights (userrights-token POST): global group memberships changed for one global account. Mirrors the core action=userrights result shape.
    ApiSetGlobalAccountStatusFailedResponseIn-band failure of action=setglobalaccountstatus: the unchanged state object is returned without reason, alongside the root error list as a nested ApiSpecMessage list rather than a standard ApiErrorResponse. Use ApiResponseWith to model either outcome.
    ApiSetGlobalAccountStatusResponseSuccessful response of action=setglobalaccountstatus. A failed lock/hide returns the unchanged state (without reason) plus an in-band root error — see ApiSetGlobalAccountStatusFailedResponse.
    ApiSetGlobalAccountStatusResultResult object of action=setglobalaccountstatus (its own token type POST): the new lock / hide state of a global account plus the reason echoed back.
    ApiSetGlobalAccountStatusStateThe lock / hide state of a global account, written by action=setglobalaccountstatus on every outcome. The success response extends it with ApiSetGlobalAccountStatusResult.reason; a failed call reports only this state, alongside the in-band root error list.
    ApiWikiSetOne list=wikisets entry: a named wiki set (a list of wikis used for global group restrictions). The key set is farm-configured.

    Type Aliases

    Type AliasDescription
    ApiGlobalUserRowOne list=globalusers row: either a found account (ApiGlobalUserFound) or a marker for a name/id that is unknown (missing), syntactically invalid (invalid), or hidden from the requester (missing again — hidden accounts are reported as absent).