(Legacy) Initiate Logout initiate-logout

NOTE
The content on this page is provided for information purposes only. Usage of this API requires a current license from Adobe. No unauthorized use is permitted.
NOTE
REST API implementation is bounded by Throttling mechanism

REST API Endpoints clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Description description

Remove AuthN and AuthZ tokens from storage.

Endpoint
Called
By
Input
Params
HTTP
Method
Response
HTTP
Response
<SP_FQDN>/api/v1/logout
Streaming App

or

Programmer Service
1. requestor
2. deviceId (Mandatory)
3. device_info/X-Device-Info (Mandatory)
4. deviceType
5. deviceUser (Deprecated)
6. appId (Deprecated)
DELETE
None
204
Input Parameter
Description
requestor
The Programmer requestorId for which this operation is valid.
deviceId
The device id bytes.
device_info/

X-Device-Info
Streaming Device information.

Note: This MAY be passed device_info as a URL paramater, but due to the potential size of this paramater and limitations on the length of a GET URL, it SHOULD be passed as X-Device-Info n the http header.

See the full details in Passing Device and Connection Information.
deviceType
The device type (e.g. Roku, PC).

If this parameter is set correctly, ESM offers metrics that are broken down per device type when using Clientless, so that different types of analysis can be performed for e.g. Roku, AppleTV, Xbox etc.

See Benefits of using the clientless device type parameter in pass metrics

Note: the device_info will replace this parameter.
deviceUser
The device user identifier.

Note: If used, deviceUser should have the same values as in the Create Registration Code request.
appId
The application id/name.

Note: the device_info replaces this parameter. If used, appId should have the same values as in the Create Registration Code request.
IMPORTANT
The logout call currently has the following limitation: it clears the AuthN and AuthZ tokens from storage (i.e., on the Programmer / Adobe Pass Authentication side), but does not call the MVPD logout endpoint.
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b