swagger: '2.0'
info:
  description: Configuration for RBA Role resource.
  version: 'v2'
  title: rba_role
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: rba_role
    description: RBA Role
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 for all the RBA roles
   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/rba_role:
    get:
      tags:
        - rba_role
      summary: GET all rba_role
      operationId: getall_rba_role
      description: Use this operation to get RBA roles
      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 rba_role 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 rba_role 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 rba_role resources.
          enum:
            - yes
      responses:
        200:
          description:  for rba_role
          schema: 
              $ref: '#/definitions/getrba_rolesResponse'
        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'

    post:
      tags:
        - rba_role
      summary: POST operation for rba_role
      operationId: post_rba_role
      description: POST operation for rba_role
      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: body
          name: rba_role
          description: rba_role object
          schema:
              $ref: '#/definitions/addrba_roleRequest'
      responses:
        200:
          description: add for rba_role
          schema: 
              $ref: '#/definitions/addrba_roleResponse'
        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/rba_role/{id}:
    get:
      tags:
        - rba_role
      summary: GET by key for rba_role
      operationId: getbykey_rba_role
      description: Use this operation to get RBA roles
      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: add for rba_role
          schema: 
              $ref: '#/definitions/getrba_roleResponse'
        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:
        - rba_role
      summary: PUT for rba_role
      operationId: putbykey_rba_role
      description: Use this operation to modify RBA role
      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: rba_role
          description: rba_role object
          schema:
              $ref: '#/definitions/modifyrba_roleRequest'
      responses:
        200:
          description: add for rba_role
          schema: 
              $ref: '#/definitions/modifyrba_roleResponse'
        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'

    delete:
      tags:
        - rba_role
      summary: Delete for rba_role
      operationId: deletebykey_rba_role
      description: Use this operation to delete RBA role(s)
      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:
        204:
          description: add for rba_role
        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:
  addrba_roleRequest:
    type: object
    required:
      - rba_role
    properties:
      rba_role:
        $ref: '#/definitions/rba_role_readwrite'
    title: addrba_roleRequest
    example:
      rba_role:
        tenant_id: "7ed7946f-4af7-11e9-99d2-b6fe81a85d18"
        name: "BLR-Site"
        description: "Session Limit"
        policies: ["string_value1","string_value2"]

  addrba_roleResponse:
    type: object
    required:
      - rba_role
    properties:
      rba_role:
        $ref: '#/definitions/rba_role'
    title: addrba_roleResponse
    example:
      rba_role:
        is_default: "false"
        tenant_id: "7ed7946f-4af7-11e9-99d2-b6fe81a85d18"
        name: "BLR-Site"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        description: "Session Limit"
        tenant_name: "AppSecDelta"
        resourcegroups: ["string_value1","string_value2"]
        groups: "ARRAY(0x299106c)"
        policies: ["string_value1","string_value2"]

  getrba_roleResponse:
    type: object
    required:
      - rba_role
    properties:
      rba_role:
        $ref: '#/definitions/rba_role'
    title: getrba_roleResponse
    example:
      rba_role:
        is_default: "false"
        tenant_id: "7ed7946f-4af7-11e9-99d2-b6fe81a85d18"
        name: "BLR-Site"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        description: "Session Limit"
        tenant_name: "AppSecDelta"
        resourcegroups: ["string_value1","string_value2"]
        groups: "ARRAY(0x299106c)"
        policies: ["string_value1","string_value2"]

  getrba_rolesResponse:
    type: object
    required:
      - rba_role
    properties:
      rba_role:
        type: array
        items:
          $ref: '#/definitions/rba_role'
    title: getrba_rolesResponse
    example:
      rba_role:
        is_default: "false"
        tenant_id: "7ed7946f-4af7-11e9-99d2-b6fe81a85d18"
        name: "BLR-Site"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        description: "Session Limit"
        tenant_name: "AppSecDelta"
        resourcegroups: ["string_value1","string_value2"]
        groups: "ARRAY(0x299106c)"
        policies: ["string_value1","string_value2"]

  modifyrba_roleRequest:
    type: object
    required:
      - rba_role
    properties:
      rba_role:
        $ref: '#/definitions/rba_role_readwrite'
    title: modifyrba_roleRequest
    example:
      rba_role:
        tenant_id: "7ed7946f-4af7-11e9-99d2-b6fe81a85d18"
        name: "BLR-Site"
        description: "Session Limit"
        policies: ["string_value1","string_value2"]

  modifyrba_roleResponse:
    type: object
    required:
      - rba_role
    properties:
      rba_role:
        $ref: '#/definitions/rba_role'
    title: modifyrba_roleResponse
    example:
      rba_role:
        is_default: "false"
        tenant_id: "7ed7946f-4af7-11e9-99d2-b6fe81a85d18"
        name: "BLR-Site"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        description: "Session Limit"
        tenant_name: "AppSecDelta"
        resourcegroups: ["string_value1","string_value2"]
        groups: "ARRAY(0x299106c)"
        policies: ["string_value1","string_value2"]

  rba_role_readwrite:
    type: object
    properties:
      tenant_id:
        description: "Tenant ID"
        type: string
        format: uuid
        minLength: 1
        maxLength: 128
      name:
        description: "Role Name"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      description:
        description: "Description of Role"
        type: string
        format: string
        minLength: 1
        maxLength: 1024
      policies:
        description: "Access policies attached to this role."
        type: array
        items:
          type: string
          format: string

  rba_role:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all the RBA roles
            type: string
            format: uuid
          groups:
             description: "Groups to which this role is assigned"
             type: array
             items:
               type: string
               format: string
      - $ref: '#/definitions/rba_role_readwrite'

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