Sign in
Sessions

Revoke the session session key.

Changed on
post/v1/sessions/revoke

Request

  • Base URL: https://api.openfort.io
  • URL: https://api.openfort.io/v1/sessions/revoke
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Headers

X-Behalf-Of-Projectstring

Project ID to act on behalf of (for ecosystem operations).

Request body

addressstring required

The address of the session key to revoke.

policystring

ID of the Policy that defines the gas sponsorship strategy (starts with pol_). If no Policy is provided, the own Account native token funds will be used to pay for gas.

optimisticboolean

Whether the transactionIntent is optimistic (resolve before it arrives on chain) or not.

chainIdinteger required

The chain ID. Must be a supported chain.

playerstring

The player ID (starts with pla_).

accountstring

ID of the Account this TransactionIntent is executed with, if one exists (starts with acc_ or dac_).

When providing a Player and ChainID, you can omit this parameter.

Example request

{
  "address": "0x1234567890abcdef1234567890abcdef12345678",
  "policy": "pol_7e07ae30-2a4d-48fa-803f-361da94905dd",
  "optimistic": true,
  "chainId": 80002,
  "player": "pla_e0b84653-1741-4a3d-9e91-2b0fd2942f60",
  "account": "acc_e1b24353-1741-4a3d-9e91-2b0fd2942f60"
}

Response

Successful response.

idstring required
object'session' required
createdAtinteger required
updatedAtinteger required
isActiveboolean required
addressstring required
validAfterstring required
validUntilstring required
whiteliststring[] required
limitinteger required

Example response

{
  "transactionIntents": [
    {
      "chainId": 5,
      "details": {
        "from": "0x8ab66318aCC6b29A27e74e534bfe3ecf81C50387",
        "data": "0x8c5a...",
        "nonce": "0",
        "gas": "21000",
        "maxFeePerGas": "1000000000",
        "maxPriorityFeePerGas": "1000000000",
        "value": "0x8ab66318aCC6b29A27e74e534bfe3ecf81C50387"
      },
      "response": {
        "error": {
          "reason": "AA31: paymaster deposit too low",
          "name": "ExecutionResult",
          "explanation": {
            "cause": "The paymaster does not have enough native tokens deposited in the EntryPoint to cover the gas cost.",
            "solution": "Top up your account balance in the dashboard or deposit more to the Paymaster contract on the relevant chain."
          }
        }
      },
      "finalCost": "0.42",
      "interactions": [
        {
          "value": "1000000000000000000",
          "contract": "con_0cddb398-1dc6-4e6f-8726-9ec7cea85f35",
          "functionName": "mint",
          "functionArgs": [
            "0x662D24Bf7Ea2dD6a7D0935F680a6056b94fE934d"
          ]
        }
      ]
    }
  ]
}

Changes

  • 5019a5edea73Revision changes
    • info

      removed from the ////// response property anyOf list for the response status

    • info

      removed the zkSync enum value from the ////// response property for the response status

  • 88be7ccfca19Revision changes
    • breaking

      the /////// response's property type changed from no type to object for status

    • info

      the endpoint scheme security auth_token was added to the API

    • info

      the endpoint scheme security better_auth was removed from the API

    • info

      the security scope sessions:write was added to the endpoint's security scheme sk

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the required property //////// to the response with the status