create Logout
POST {{baseUrl}}/api/logout?global=<string>&refreshToken=<string>
The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API does nothing if the request does not contain an access token or refresh token cookies. OR The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the client and revoke the refresh token stored. This API takes the refresh token in the JSON body.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
global | string | When this value is set to true all the refresh tokens issued to the owner of the provided token will be revoked. | |
refreshToken | string | The refresh_token as a request parameter instead of coming in via a cookie. If provided this takes precedence over the cookie. |
Request Body
{"global"=>"<boolean>", "refreshToken"=>"<string>", "eventInfo"=>{"deviceDescription"=>"<string>", "deviceName"=>"<string>", "deviceType"=>"<string>", "ipAddress"=>"<string>", "location"=>{"city"=>"<string>", "country"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>", "region"=>"<string>", "zipcode"=>"<string>", "displayString"=>"<string>"}, "os"=>"<string>", "userAgent"=>"<string>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
""