openapi: 3.2.0
info:
  title: CoreStack External Assessment API
  version: 1.0.0
  termsOfService: http://corestack.io/
  license:
    name: CoreStack Inc License
    url: http://corestack.io/licenses/LICENSE-2.0.html
  description: Manage Assessment
servers:
- url: /
tags:
- name: Assessment
  description: Manage Assessment
paths:
  /governance/account/settings/access/post/{tenant_id}:
    post:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentValidationResponseList'
      summary: Assessment Validation
      description: Analyse the access requirements for the given cloud account.
      operationId: AssessmentValidation
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Assessment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssessmentValidationRequest'
        required: true
  /governance/account/{tenant_id}/compliance_standards/{cloud_account_id}/get_configurations:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentComplianceResponse'
      summary: Assessment Compliance Validation
      description: Creates a Assessment Validation list for compliance under the tenant.
      operationId: AssessmentComplianceValidation
      parameters:
      - name: tenant_id
        in: path
        required: true
        description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.
        schema:
          type: string
      - name: cloud_account_id
        in: path
        required: true
        description: ID of the cloud account. This can be fetched from ListCloudAccounts API
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Assessment
components:
  schemas:
    AssessmentValidationResponseList:
      required:
      - assessment_validation_list
      properties:
        assessment_validation_list:
          type: array
          description: Assessment Validation data
          items:
            $ref: '#/components/schemas/AssessmentValidationResponse'
      type: object
    AssessmentComplianceResponse:
      properties:
        configuration_status:
          type: string
          description: Configuration Status
        summary:
          type: object
          description: Summary of validation result
      type: object
    AssessmentValidationRequest:
      required:
      - category
      - cloud_account_id
      - validation_type
      properties:
        cloud_account_id:
          type: string
          description: Cloud Account Id
        category:
          type: string
          description: Name of the category
          example: operations
          enum:
          - operations
          - security
          - access
          - cost
          - resource
          - compliance
          x-cs-enum-type: AssessmentCategory
        validation_type:
          type: string
          description: Type of Validation
      type: object
    ModelError:
      required:
      - message
      properties:
        message:
          type: string
          description: Error response message.
      type: object
    AssessmentValidationResponse:
      required:
      - mandatory_requirements
      - optional_requirements
      - status
      - sub_category
      properties:
        sub_category:
          type: string
          description: Sub Category of Assessment
        status:
          type: string
          description: Status of Assessment Validation
        mandatory_requirements:
          type: object
          description: Mandatory Requirements
        optional_requirements:
          type: object
          description: Optional Requirements
        configuration_status:
          type: object
          description: Configuration Status
      type: object
  securitySchemes:
    auth_token:
      type: apiKey
      in: header
      name: X-Auth-Token