swagger: '2.0'
info:
  description: Configuration for User Lockout Policy configuration resource.
  version: 'v2'
  title: user_lockout_policy
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: user_lockout_policy
    description: User Lockout Policy configuration
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Id is system generated key
   required: true
  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/user_lockout_policy:
    get:
      tags:
        - user_lockout_policy
      summary: GET all user_lockout_policy
      operationId: getall_user_lockout_policy
      description: Use this operation to get User Lockout Policy details
      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: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the user_lockout_policy resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the user_lockout_policy resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of user_lockout_policy resources.
          enum:
            - yes
      responses:
        200:
          description:  for user_lockout_policy
          schema: 
              $ref: '#/definitions/getuser_lockout_policysResponse'
        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'

  /massvc/{customerid}/nitro/v2/config/user_lockout_policy/{id}:
    get:
      tags:
        - user_lockout_policy
      summary: GET by key for user_lockout_policy
      operationId: getbykey_user_lockout_policy
      description: Use this operation to get User Lockout Policy details
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - 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
      responses:
        200:
          description:  for user_lockout_policy
          schema: 
              $ref: '#/definitions/getuser_lockout_policyResponse'
        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'

    put:
      tags:
        - user_lockout_policy
      summary: PUT for user_lockout_policy
      operationId: putbykey_user_lockout_policy
      description: Use this operation to modify User Lockout Policy details
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - 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: body
          name: user_lockout_policy
          description: user_lockout_policy object
          schema:
              $ref: '#/definitions/modifyuser_lockout_policyRequest'
      responses:
        200:
          description:  for user_lockout_policy
          schema: 
              $ref: '#/definitions/modifyuser_lockout_policyResponse'
        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:
  getuser_lockout_policyResponse:
    type: object
    required:
      - user_lockout_policy
    properties:
      user_lockout_policy:
        $ref: '#/definitions/user_lockout_policy'
    title: getuser_lockout_policyResponse
    example:
      user_lockout_policy:
        user_lockout_interval: "5"
        invalid_logins: "3"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        enable_user_lockout: "false"

  getuser_lockout_policysResponse:
    type: object
    required:
      - user_lockout_policy
    properties:
      user_lockout_policy:
        type: array
        items:
          $ref: '#/definitions/user_lockout_policy'
    title: getuser_lockout_policysResponse
    example:
      user_lockout_policy:
        user_lockout_interval: "5"
        invalid_logins: "3"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        enable_user_lockout: "false"

  modifyuser_lockout_policyRequest:
    type: object
    required:
      - user_lockout_policy
    properties:
      user_lockout_policy:
        $ref: '#/definitions/user_lockout_policy_readwrite'
    title: modifyuser_lockout_policyRequest
    example:
      user_lockout_policy:
        user_lockout_interval: "5"
        invalid_logins: "3"
        enable_user_lockout: "false"

  modifyuser_lockout_policyResponse:
    type: object
    required:
      - user_lockout_policy
    properties:
      user_lockout_policy:
        $ref: '#/definitions/user_lockout_policy'
    title: modifyuser_lockout_policyResponse
    example:
      user_lockout_policy:
        user_lockout_interval: "5"
        invalid_logins: "3"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        enable_user_lockout: "false"

  user_lockout_policy_readwrite:
    type: object
    properties:
      user_lockout_interval:
        description: "User lockout Interval in minutes"
        type: integer
        format: int32
      invalid_logins:
        description: "No of invalid logins for User lockout "
        type: integer
        format: int32
      enable_user_lockout:
        description: "Enable user User lockout feature"
        type: boolean
        format: boolean

  user_lockout_policy:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: string
      - $ref: '#/definitions/user_lockout_policy_readwrite'

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