Deauthorisation

Deauthorisation is the process whereby the client asks the TWeb Public API to immediately expire the Access Token. This process is optional, since the Access Token will expire 30 minutes after it is issued anyway. However for the sake of security it is still recommended that the client deauthorise.

Request

The deauthorisation endpoint depends on the server used by your company to login to TWeb:

The endpoint only accepts HTTP POST requests. The following parameter must be submitted with the request:

accessToken

Note that the Access Token may be submitted as a POST parameter or as a HTTP Cookie.

The following POST parameter may optionally be submitted with the request:

targetID

For details regarding the Target ID, please refer to the following article: https://help.tweb.com.au/TWebPublicAPI/en/Authorisation/Execute#heading_request

Request Example

A request that includes the Access Token from the file where it was stored during authorisation:

curl -b cookiejar.txt -skX POST -d "" https://publicapi.tweb.com.au/v1/Deauthorise

A request that includes the Access Token as a POST parameter in the response body:

curl -skX POST -d "accessToken=0123456789ABCDEF0123456789ABCDEF01234567" https://publicapi.tweb.com.au/v1/Deauthorise

Response

The response from the deauthorisation endpoint has the following JSON format:

{
    "Data": {
        "Items": [],
        "Meta": {
            "Endpoint": "/v1/Deauthorise",
            "Title": "Public API: Deauthorisation"
        }
    },
    "Error": {
        "Code": 0,
        "Status": "OK"
    }
}

The possible Error responses during deauthorisation are: