messages.checkUrlAuthMatchCode

Validate the match code selected by the user against the code shown on the login page, as part of the OAuth authorization flow ».Only usable when both match_codes and match_codes_first are set in the urlAuthResultRequest returned by messages.requestUrlAuth. If boolTrue is returned, proceed with the login flow and pass the verified code to messages.acceptUrlAuth.match_code.

API section: Working with OAuth login

messages.checkUrlAuthMatchCode#c9a47b0b url:string match_code:string = Bool;

Parameters

NameTypeDescription
url string URL.
match_code string

Result

Bool

Possible errors

This method has no errors of its own: it either answers or fails on the shared checks below.

Common to every call

CodeTypeWhat it means
401 AUTH_KEY_UNREGISTERED The server does not know this session: the key was revoked, expired, or the call was made before authorisation.
401 API_ID_INVALID This api_id was never issued or has been blocked. Keys come from my.ansible.su.
400 CONNECTION_LAYER_INVALID The client did not declare a layer, or declared one the server does not know.
420 FLOOD_WAIT_X Too often. Do not retry for X seconds — the number arrives in the error text.
500 INTERNAL A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours.

Related pages

Types used here