Logout operation

The Logout operation enables you to close the web service session and log out from BMC Network Automation. The following table describes the elements for the <items> XML element and adapter request for the Logout operation.

Elements for the <items> XML element and adapter request for the Logout operation

Element	Definition	Required
`<entity>`	Specifies the type of operation: `authentication`	Yes
`<operation-name>`	Specifies the name of operation: `do-logout`	Yes
`<user-token>`	Specifies the session token returned during the execution of the Login operation	Yes

The following figure shows a sample <items> XML element for the Logout operation.

<items> XML element for the Logout operation

<items>
  <item>
    <parameters>
      <user-token>-6800902384833057908</user-token>
    </parameters>
  </item>
</items>

The following figure shows a sample adapter request for the Logout operation.

Sample adapter request for the Logout operation

<bmc-configuration-automation-networks-request>
    <entity>authentication</entity>
    <request>
        <operation-name>do-logout</operation-name>
        <parameters>
            <user-token>-6800902384833057908</user-token>
        </parameters>
    </request>
</bmc-configuration-automation-networks-request>

The following figure illustrates the response for the sample Logout operation.

Adapter response for the Logout operation

<bmc-configuration-automation-networks-response>
  <metadata>
    <status>success</status>
  </metadata>
  <parameters>
    <output>true</output>
  </parameters>
</bmc-configuration-automation-networks-response>

The response parameter has a Boolean value of either:

true: The user is successfully logged out.
false: The logout operation cannot be completed because the user is not logged in.

Logout operation

Comments