revokeAccessToken

Description

Revokes the access token.

Syntax

oauth2.revokeAccessToken (service_key, client, access_token)

Parameters

Parameter Type Description
service_key string The id of the OAuth 2.0 protected service definition
client client object A client object containing at least the client_id
access_token string Access token to revoke

Return Value

Boolean

Errors

Standard JSON-RPC errors.

Sample Requests and Responses

Sample Request (Ordered Parameters):

{
   "method":"oauth2.revokeAccessToken",
   "params":[
      "rmeqcgpw3zu2y47y9bs8vs2h",
      {
         "client_id":"qrqefasdfjp98"
      },
      "SlAV32hkKG"
   ],
   "id":1
}

Sample Request (Named Parameters):

{
   "jsonrpc":"2.0",
   "method":"oauth2.revokeAccessToken",
   "params":[
      "service_key":"rmeqcgpw3zu2y47y9bs8vs2h",
      "client":
      {
         "client_id":"qrqefasdfjp98"
      },
      "access_token":"SlAV32hkKG"
   ],
   "id":1
}

Sample Response

{
   "jsonrpc":"2.0",
   "result":true,
   "id":1
}

Docs Navigation