logout

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Ends a user's login session, invalidating the cookie value associated with the user's session.

After calling logout, set the BREEZESESSION cookie value to null. Do not reuse the cookie value after your user logs out.

Request URL

http://server_name/api/xml
    ?action=logout
    &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue /> 
</results>

Response values

Element

Attribute

Type

Description

results  

Container

All results the action returns.

status  

Empty, with attributes

The status of the response.

  code

Allowed value

A code indicating the response status (see status).

Sample request

http://example.com/api/xml?action=logout

Sample response

<?xml version="1.0" encoding="utf-8" ?>
<results>
    <status code="ok" />
</results>

See also

login



Take a survey


 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/04a_ac15.htm