API:Authmanagerinfo/cs

Authmanagerinfo
Získání informací potřebných pro procesy ověřování.
Tento modul nelze použít jako zdroj.
Předpona ami
Požadovaná práva žádná
Pouze příspěvek? Ne
Zdroj nápovědy Aktuální
Přidaná verze
≥ 1.27

Vrátí informace potřebné pro ověřovací procesy na základě hodnoty AuthManager. Kód pro modul authmanagerinfo se nachází na adrese ApiQueryAuthManagerInfo.php.

Parametry

  • amisecuritysensitiveoperation: Otestuje, zda je aktuální stav ověřování uživatele dostatečný pro zadanou operaci citlivou z hlediska zabezpečení.
  • amirequestsfor: Načte informace o požadavcích na ověření potřebných pro zadanou akci ověření. Možné hodnoty: login, login-continue, create, create-continue, link, link-continue, change, remove, unlink
  • amimergerequestfields: Sloučí informace o polích pro všechny požadavky na ověření do jednoho pole. Typ: boolean
  • amimessageformat: Formát, který se má použít při odesílání zpráv zpět. Možné hodnoty: html, wikitext, raw, none

Odpověď

Odpověď bude vždy obsahovat následující booleovská pole:

  • canauthenticatenow – označující, zda je pro aktuální relaci možné přihlášení.
  • cancreateaccounts – označující, zda je pro aktuální relaci možné vytvořit účet.
  • canlinkaccounts – označující, zda je propojení účtů pro aktuální relaci možné.

If amisecuritysensitiveoperation was provided, securitysensitiveoperationstatus will be returned indicating the security status of the operation: ok if the operation may proceed, reauth if reauthentication is required, or fail if the operation is not available.

If amirequestsfor was provided, a requests property will be returned with information on the AuthManager authentication requests that may be supplied for the authentication action. If amimergerequestfields was also provided, a fields property with merged field data will also be returned, otherwise the field data for each request will be included as part of the request data.

Data požadavku na ověření

Data požadavku na ověření popisují další pole, která je třeba poskytnout pro ověřovací akci.

  • id - identifikátor požadaveku.
  • metadata - metadata o požadavku, která by mohla být užitečná pro klienta API.
  • required - zda je požadavek povinný. Hodnota je jeden z následujících řetězců:
    • required - požadavek je povinný, tj. ověřovací akce selže, pokud nebudou jeho pole zadána.
    • optional - požadavek není povinný, tj. lze očekávat, že ověřovací akce proběhne normálně, i když je požadavek ignorován.
    • primary-required - aby mohla akce ověřování pokračovat, musí být v jednom z několika požadavků označených jako primary-required uvedena svá pole.
  • provider - zpráva určená jako čitelná zpráva popisující poskytovatele tohoto požadavku na ověření, ale nemusí být implementována pro požadavky, u kterých se nepovažuje za pravděpodobné použití v kontextu, kde by se to zobrazovalo. The amimessageformat and uselang parameters control the format and language used.
  • account - zpráva je určena jako čitelná zpráva popisující konkrétní účet, na který se odkazuje tento požadavek na ověření, ale nemusí být implementována pro požadavky, u kterých se nepovažuje za pravděpodobné, že budou použity v kontextu, kde by se to zobrazovalo. The amimessageformat and uselang parameters control the format and language used.
    • Například požadavek reprezentující účet pro user@example.com na adrese openid.example.net může mít pole provider "OpenID služba v example.net“ a pole account pro user@example.com.
  • fields - popisuje jednotlivé parametry POST, které požadavek potřebuje.
    • type - Data type of the field. Values below are compared to data returned from the paraminfo action.
      • string - The same as the string paraminfo type.
      • password - The same as the password paraminfo type.
      • select - Paraminfo would return an array of possible values.
      • checkbox - The same as the boolean paraminfo type.
      • button - The same as the boolean paraminfo type. At most one button-type parameter should be included in the request, as this is intended to be equivalent to a submit button in an HTML form.
      • multiselect - Paraminfo would return an array of possible values, and the multi field would be true.
      • hidden - The field isn't intended to be displayed to the user. The value should generally be sent back to the server unchanged.
      • null - Represents explanatory text for the user interface with no associated field in the submission.
    • value - Value for the field. If the user input doesn't override this, it should be used when the field is submitted.
    • options - For select and multiselect types, this is an associative array containing the list of possible values. Keys are the values to be submitted, and values are the human-readable text corresponding to each option (language selected by uselang).
    • label - Human-readable label for the form field. The amimessageformat and uselang parameters control the format and language used.
    • help - Human-readable description for the form field. The amimessageformat and uselang parameters control the format and language used.
    • optional - Boolean indicating whether the field is optional. An authentication request is only valid if all its non-optional fields are provided. Note that, in the case of checkboxes or buttons, this means the boolean field must have a true value.
    • sensitive - Boolean indicating whether the field is considered sensitive. Sensitive fields are things such as passwords that generally shouldn't be displayed, logged, or cached. As such, these fields must be in the POST body rather than in the URL query.
Category:MediaWiki API/cs
Category:MediaWiki API/cs