swagger: '2.0'
info:
  description: Configuration for Logout resource.
  version: 'v2'
  title: logout
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: logout
    description: Logout
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/logout:
    post:
      tags:
        - logout
      summary: POST operation for logout
      operationId: post_logout
      description: POST operation for logout
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: onerror
          description: Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
          required: false
          type: string
          default: CONTINUE
          enum:
            - EXIT
            - CONTINUE
        - in: query
          name: action
          type: string
          required: false
          enum: [delete]
          description: >
            actions:
              * `delete` - Logout

        - in: body
          name: logout
          description: logout object
          schema:
              $ref: '#/definitions/addlogoutRequest'
      responses:
        200:
          description: delete for logout
          schema: 
              $ref: '#/definitions/addlogoutResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  addlogoutRequest:
    type: object
    required:
      - logout
    properties:
      logout:
        $ref: '#/definitions/logout_readwrite'
    title: addlogoutRequest
    example:
      logout:
        sessionid: "##CD73D85621DAF50D8ECA21D26365DB59390EF614D324BB84521D2F5401C0"

  addlogoutResponse:
    type: object
    required:
      - logout
    properties:
      logout:
        $ref: '#/definitions/logout'
    title: addlogoutResponse
    example:
      logout:
        password: "password"
        session_timeout: "86400"
        sessionid: "##CD73D85621DAF50D8ECA21D26365DB59390EF614D324BB84521D2F5401C0"
        username: "nsroot"

  logout_readwrite:
    type: object
    properties:
      sessionid:
        description: "Session ID would only be set if login was performed successfully"
        type: string
        format: string

  logout:
    allOf:
      - $ref: '#/definitions/logout_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
