Web API Reference Guide > Available API Methods > Z-Ray Methods > The zrayExpireAccessToken Method

The zrayExpireAccessToken Method

Expires a passed access token.

Version: 1.8

Required Permissions: Read-only

HTTP method: POST

Supported Editions: Zend Server

Request parameters:

Parameter

 Type

Required

Description

tokenId

Integer

Yes

The identifier for the token to be expired. Note that this is a number representing the token, not the token itself.

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: backtraceRow

Possible Action Specific Error Codes: This action has no specific error codes

Example

Usage Example

Request (headers removed for the purpose of clarity)

POST /ZendServer/Api/zrayExpireAccessToken?tokenId=2

Response (not all headers are shown)

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.8">

<requestData>

<apiKeyName>angel.eyes</apiKeyName>

<method>zrayExpireAccessToken</method>

</requestData>

<responseData>

<acccessToken>

<tokenId>2</tokenId>

<hash><![CDATA[...]]></hash>

<iprange><![CDATA[...]]></iprange>

<baseUrl><![CDATA[...]]></baseUrl>

<ttl>...</ttl>

<title><![CDATA[...]]></title>

</accessToken>

</responseData>

</zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Z-Ray Methods