> For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/llms-full.txt.

# CentralAuth

## Interfaces

| Interface                                                                                                                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [ApiCentralAuthInBandErrorResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthInBandErrorResponse.md)             | In-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.                                                                                                                                                                                                                                                                                                                         |
| [ApiCentralAuthTokenResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCentralAuthTokenResponse.md)                         | Response 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`).                                                                                                                                                                             |
| [ApiCreateLocalAccountResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResponse.md)                     | Response of `action=createlocalaccount`. Unlike `setglobalaccountstatus`, a failure returns only the root `error` list and no result object.                                                                                                                                                                                                                                                                                                                                                                                                                               |
| [ApiCreateLocalAccountResult](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiCreateLocalAccountResult.md)                         | Result of `action=createlocalaccount` (CSRF-token POST, `centralauth-createlocal` right): a local account was force-created on this wiki for the global account.                                                                                                                                                                                                                                                                                                                                                                                                           |
| [ApiDeleteGlobalAccountResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResponse.md)                   | Response of `action=deleteglobalaccount`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| [ApiDeleteGlobalAccountResult](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiDeleteGlobalAccountResult.md)                       | Result of `action=deleteglobalaccount` (its own token type POST): the global account was unmerged (deleted).                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| [ApiGlobalCentralUser](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalCentralUser.md)                                       | One `list=globalallusers` entry. `aguprop` controls which fields beyond [ApiGlobalCentralUser.id](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalCentralUser.md#id) / [ApiGlobalCentralUser.name](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalCentralUser.md#name) appear. Hidden accounts (suppressed from public lists) never appear here at all.                                                                                                                                                     |
| [ApiGlobalGroup](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalGroup.md)                                                   | One `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.                                                                                                                                                                                                                                                                                                                                                               |
| [ApiGlobalGroupMembership](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalGroupMembership.md)                               | One global group membership of a `list=globalusers` row.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| [ApiGlobalUserFound](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md)                                           | One `list=globalusers` entry for an existing global account. `gusprop` controls which fields beyond [ApiGlobalUserFound.centralid](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md#centralid) / [ApiGlobalUserFound.name](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md#name) appear. Results come back in request order; unknown names/ids get marker rows (see [ApiGlobalUserRow](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRow.md)). |
| [ApiGlobalUserInvalidName](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserInvalidName.md)                               | A `list=globalusers` row for a requested name that is not a valid username.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| [ApiGlobalUserLocalInfo](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserLocalInfo.md)                                   | The `localinfo` object of a `list=globalusers` row.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| [ApiGlobalUserMissingId](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserMissingId.md)                                   | A `list=globalusers` row for a requested global id with no global account.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| [ApiGlobalUserMissingName](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserMissingName.md)                               | A `list=globalusers` row for a requested name with no global account.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| [ApiGlobalUserRightsResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResponse.md)                         | Response of `action=globaluserrights`. Failures are standard top-level errors.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| [ApiGlobalUserRightsResult](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRightsResult.md)                             | Result of `action=globaluserrights` (userrights-token POST): global group memberships changed for one global account. Mirrors the core `action=userrights` result shape.                                                                                                                                                                                                                                                                                                                                                                                                   |
| [ApiSetGlobalAccountStatusFailedResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusFailedResponse.md) | In-band failure of `action=setglobalaccountstatus`: the unchanged state object is returned without `reason`, alongside the root `error` list as a nested [ApiSpecMessage](https://types-mediawiki-response.pages.dev/api/core/ApiSpecMessage.md) list rather than a standard `ApiErrorResponse`. Use `ApiResponseWith` to model either outcome.                                                                                                                                                                                                                            |
| [ApiSetGlobalAccountStatusResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResponse.md)             | Successful response of `action=setglobalaccountstatus`. A failed lock/hide returns the unchanged state (without `reason`) plus an in-band root `error` — see [ApiSetGlobalAccountStatusFailedResponse](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusFailedResponse.md).                                                                                                                                                                                                                                                  |
| [ApiSetGlobalAccountStatusResult](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResult.md)                 | Result object of `action=setglobalaccountstatus` (its own token type POST): the new lock / hide state of a global account plus the reason echoed back.                                                                                                                                                                                                                                                                                                                                                                                                                     |
| [ApiSetGlobalAccountStatusState](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusState.md)                   | The lock / hide state of a global account, written by `action=setglobalaccountstatus` on every outcome. The success response extends it with [ApiSetGlobalAccountStatusResult.reason](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiSetGlobalAccountStatusResult.md#reason); a failed call reports only this state, alongside the in-band root `error` list.                                                                                                                                                                                    |
| [ApiWikiSet](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiWikiSet.md)                                                           | One `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 Alias                                                                                                    | Description                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [ApiGlobalUserRow](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserRow.md) | One `list=globalusers` row: either a found account ([ApiGlobalUserFound](https://types-mediawiki-response.pages.dev/api/extensions/centralauth/ApiGlobalUserFound.md)) 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). |
