Documentation

Fields

• user_id :: Maybe Int

  Identifier of the user for which the link was generated; may be 0 if unknown. The corresponding user may be unknown. If the user is logged in the application, then they must be chosen for authorization by default

• url :: Maybe Text

  An HTTP URL where the user authorizes

• domain :: Maybe Text

  A domain of the URL

• from_app :: Maybe Bool

  True, if the authorization originates from an application

• verified_app_name :: Maybe Text

  Verified name of the application; if empty, then "Unverified App" must be shown instead

• bot_user_id :: Maybe Int

  User identifier of a bot linked with the website

• request_write_access :: Maybe Bool

  True, if the user must be asked for the permission to the bot to send them messages

• request_phone_number_access :: Maybe Bool

  True, if the user must be asked for the permission to share their phone number

• request_ton_wallet_access :: Maybe Bool

  True, if access to the user's TON wallet is requested by the app. If true and the user agrees to give access, then use createTonConnectSession with dapp_client_id and ton_connect_manifest_url to create the TON Connect session, then setTonConnectSessionWalletClientId, then create a tonWalletOwnershipProof for the given domain with the payload ton_proof_payload, and then pass all data to acceptOauthRequest in the parameter ton_connect_connect_data

• dapp_client_id :: Maybe Text

  Hex-encoded public X25519 key of the dApp; may be empty if TON wallet access wasn't requested

• ton_connect_manifest_url :: Maybe Text

  URL of the TON Connect manifest of the dApp; may be empty if TON wallet access wasn't requested

• ton_proof_payload :: Maybe Text

  Payload for TON wallet ownership proof; may be empty if TON wallet access wasn't requested

• browser :: Maybe Text

  The version of a browser used for the authorization

• platform :: Maybe Text

  Operating system the browser is running on

• ip_address :: Maybe Text

  IP address from which the authorization is performed, in human-readable format

• location :: Maybe Text

  Human-readable description of a country and a region from which the authorization is performed, based on the IP address

• match_code_first :: Maybe Bool

  True, if code matching dialog must be shown first and checkOauthRequestMatchCode must be called before acceptOauthRequest. Otherwise, checkOauthRequestMatchCode must not be called

• match_codes :: Maybe [Text]

  The list of codes to match; may be empty if irrelevant