미디어위키 API 도움말

이 페이지는 자동으로 생성된 미디어위키 API 도움말 문서입니다.

설명 문서 및 예시: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

(main | clientlogin)

이 모듈은 write 권한을 요구합니다.
이 모듈은 POST 요청만을 허용합니다.
출처: MediaWiki
라이선스: GPL-2.0-or-later

상호작용 플로우를 이용하여 위키에 로그인합니다.

이 모듈을 사용하는 일반적인 절차는 다음과 같습니다:

amirequestsfor=login와 함께 action=query&meta=authmanagerinfo에서 사용할 수 있는 필드와 action=query&meta=tokens의 토큰을 가져옵니다.
사용자에게 필드를 제시하고 사용자의 제출 사항을 취득합니다.
loginreturnurl 및 관련된 모든 필드를 제공, 이 모듈에 전달합니다.
응답 시 status를 확인합니다.
- PASS 또는 FAIL을 수신한 경우 작업은 끝난 것입니다. 동작은 성공하였거나 그렇지 않은 경우입니다.
- UI를 수신한 경우 사용자에게 새로운 필드를 제시하고 사용자의 제출 사항을 취득합니다. 그 뒤 logincontinue 및 관련된 모든 필드 집합과 함께 이 모듈에 전달하고 단계 4를 반복합니다.
- REDIRECT를 수신한 경우, 사용자를 redirecttarget으로 넘겨준 다음 loginreturnurl로 반환될 때까지 기다립니다. 그 뒤 logincontinue 및 반환 URL에 전달되는, 모든 관련 필드와 함께 이 모듈에 전달하고 단계 4를 반복합니다.
- RESTART를 수실한 경우 인증은 동작했으나 연결된 사용자 계정이 없다는 것을 의미합니다. UI나 FAIL로 간주할 수 있습니다.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login

특정 변수:

Other general parameters are available.

loginrequests

amirequestsfor=login와(과) 함께 action=query&meta=authmanagerinfo에서 반환된 id를 통해, 또는 이 모듈의 과거 응답으로부터 이 인증 요청만을 사용합니다.

| 또는 대안으로 값을 구분합니다.

값의 최대 수는 50(더 높은 제한이 허용된 클라이언트의 경우 500)입니다.

loginmessageformat

반환 메시지에 사용할 형식.

다음 값 중 하나: html, none, raw, wikitext 또는 다른 문자열: html, none, raw, wikitext

기본값: wikitext

loginmergerequestfields

모든 인증 요청에 대한 필드 정보를 하나의 배열로 합칩니다.

유형: 불리언 (자세한 정보)

loginpreservestate

가능하면 과거에 실패한 로그인 시도의 상태를 보존합니다.

유형: 불리언 (자세한 정보)

loginreturnurl

서드파티 인증 플로의 URL을 반환하며, 절대 주소여야 합니다. 이것 또는 logincontinue는 필수입니다.

REDIRECT 응답을 받으면 일반적으로 서드파티 인증 플로를 위해 지정한 redirecttarget URL에 대해 브라우저나 웹 뷰를 열게 됩니다. 이 작업이 끝나면 서드파티는 브라우저나 웹 뷰를 이 URL로 보냅니다. URL로부터 쿼리나 POST 변수를 추출한 다음 이것들을 logincontinue 요청으로서 이 API 모듈로 전달하는 것이 좋습니다.

logincontinue

이 요청은 초기 UI 또는 REDIRECT 응답 이후에 계속됩니다. 이것 또는 loginreturnurl 중 하나가 필요합니다.

유형: 불리언 (자세한 정보)

logintoken

"login" 토큰은 action=query&meta=tokens에서 가져옵니다

이 변수는 필수입니다.

*

이 모듈은 사용 가능한 인증 요청에 따라 추가 변수를 허용합니다. 사용 가능한 요청 및 사용되는 필드를 결정하려면 amirequestsfor=login(또는 해당되는 경우 이 모듈의 과거 응답)과 함께 action=query&meta=authmanagerinfo을(를) 사용하십시오.

예시:

사용자 Example, 비밀번호 ExamplePassword로 위키 로그인 과정을 시작합니다.: api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [연습장에서 열기]
987654의 OATHToken을 지정하여 2요소 인증을 위한 UI 응답 이후에 로그인을 계속합니다.: api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [연습장에서 열기]