openapi: 3.2.0
info:
  title: CoreStack External Service Account Resources 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 Service Account Resources
servers:
- url: /
tags:
- name: Service Account Resources
  description: Manage Service Account Resources
paths:
  /v1/security/threat/{service_account_id}/gcp/validate:
    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: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityThreatValidationForGCPResponse'
      summary: Threat Validation for GCP Services
      description: Security Threat Validation for GCP
      operationId: ThreatValidationForGCP
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v1/security/threat/{service_account_id}/oci/validate:
    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: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityThreatValidationForOCIResponse'
      summary: Threat Validation for OCI services
      description: Security Threat Validation for OCI
      operationId: ThreatValidationForOCI
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v1/security/vulnerability/{service_account_id}/gcp/validate:
    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: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityVulnerabilityValidationForGCPResponse'
      summary: Vulnerability Validation for GCP Services
      description: Security Vulnerability Validation for GCP
      operationId: VulnerabilityValidationForGCP
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v1/security/vulnerability/{service_account_id}/oci/validate:
    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: Fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityVulnerabilityValidationForOCIResponse'
      summary: Vulnerability Validation for OCI services
      description: Security Vulnerability Validation for OCI
      operationId: VulnerabilityValidationForOCI
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/aws/buckets:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Not Found
          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:
                type: array
                items:
                  type: string
      summary: List Available AWS S3 Buckets
      description: List the available AWS S3 buckets for the cloud account
      operationId: ListAvailableAwsBuckets
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/aws/trails/{region}:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Not Found
          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:
                type: array
                items:
                  $ref: '#/components/schemas/AwsTrailDetails'
      summary: List Available AWS CloudTrail By Region
      description: List the AWS CloudTrail of a region on cloud account
      operationId: ListAvailableAwsTrailsByRegion
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      - name: region
        in: path
        required: true
        description: Specify the region to fetch trails
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/azure/action_groups:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Not Found
          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:
                type: array
                items:
                  $ref: '#/components/schemas/AzureActionGroupDetails'
      summary: List Available Azure Action Groups
      description: List the available Azure action groups for the cloud account
      operationId: ListAvailableAzureActionGroups
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/azure/activity_log_alerts:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Not Found
          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:
                type: array
                items:
                  $ref: '#/components/schemas/AzureActivityLogAlertDetails'
      summary: List Available Azure Activity Log Alerts
      description: List the available Azure activity log alerts for the cloud account
      operationId: ListAvailableAzureActivityLogAlerts
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/azure/log_analytics_workspaces:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Not Found
          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:
                type: array
                items:
                  $ref: '#/components/schemas/AzureLogAnalyticsWorkspaceDetails'
      summary: List Available Azure Log Analytics Workspaces
      description: List the available Azure log analytics workspaces for the cloud account
      operationId: ListAvailableAzureLogAnalyticsWorkspaces
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/azure/subscriptions:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Not Found
          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:
                type: array
                items:
                  $ref: '#/components/schemas/AzureSubscriptionDetails'
      summary: List Available Azure Subscriptions
      description: List the available Azure subscriptions for the cloud account
      operationId: ListAvailableAzureSubscriptions
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/billing_metrics:
    parameters:
    - name: service_account_id
      in: path
      required: true
      schema:
        type: string
    get:
      responses:
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '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:
                type: array
                items:
                  type: string
      summary: List billing metrics for a cloud account
      description: List the billing metrics for an account
      operationId: ListBillingMetricsForAnAccount
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/gcp/buckets:
    get:
      responses:
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '404':
          description: Not Found
          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:
                type: array
                items:
                  type: string
      summary: List Available GCS Buckets
      description: List the available GCS buckets for the cloud account
      operationId: ListAvailableGcsBuckets
      parameters:
      - name: service_account_id
        in: path
        required: true
        description: Specify the account id
        schema:
          type: string
      security:
      - auth_token: []
      tags:
      - Service Account Resources
  /v2/service_account/item/{service_account_id}/github/repositories:
    parameters:
    - name: service_account_id
      in: path
      required: true
      schema:
        type: string
    get:
      responses:
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelError'
        '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:
                type: array
                items:
                  $ref: '#/components/schemas/RepositoryDetail'
      summary: List the repositories in a gitHub account
      description: List the repositories for a github account
      operationId: ListGithubRepositories
      security:
      - auth_token: []
      tags:
      - Service Account Resources
components:
  schemas:
    SecurityVulnerabilityValidationForGCPResponse:
      properties:
        web_security_scanner:
          type: boolean
          description: If set, Web Security Scanner is enabled.
        security_health_analytics:
          type: boolean
          description: If set, Security Health Analytics is enabled.
      type: object
    RepositoryDetail:
      properties:
        repository_id:
          type: string
          description: Unique Identifier of the Repository.
        repository_name:
          type: string
          description: Unique Name of the Repository.
      type: object
    AzureSubscriptionDetails:
      properties:
        subscription_id:
          type: string
          description: Subscription Id
        name:
          type: string
          description: Subscription Name
        status:
          type: string
          description: Azure Subscription Status
          example: Deleted
          enum:
          - Deleted
          - Disabled
          - Enabled
          - PastDue
          - Warned
          x-cs-enum-type: AzureSubscriptionStatus
      type: object
    AwsTrailDetails:
      properties:
        name:
          type: string
          description: Name of the trail
        bucket_name:
          type: string
          description: Name of the Amazon S3 bucket into which CloudTrail delivers trail files
        is_multi_region_trail:
          type: boolean
          description: Specifies whether the trail exists only in one Region or exists in all Regions
      type: object
    SecurityVulnerabilityValidationForOCIResponse:
      properties:
        host_scan_target:
          type: boolean
          description: If set, Host Scan Target is enabled.
      type: object
    SecurityThreatValidationForGCPResponse:
      properties:
        event_threat_detection:
          type: boolean
          description: If set, Event Threat Detection is enabled.
        container_threat_detection:
          type: boolean
          description: If set, Container Threat Detection is enabled.
      type: object
    ModelError:
      required:
      - message
      properties:
        message:
          type: string
          description: Error response message.
      type: object
    SecurityThreatValidationForOCIResponse:
      properties:
        cloud_guard:
          type: boolean
          description: If set, Cloud Guard is enabled.
      type: object
    AzureActionGroupDetails:
      properties:
        name:
          type: string
          description: Action Group Name
        resource_group:
          type: string
          description: Resource Group Name
      type: object
    AzureActivityLogAlertDetails:
      properties:
        name:
          type: string
          description: Activity Log Alert Name
        resource_group:
          type: string
          description: Resource Group Name
        is_subscription_scope:
          type: boolean
          description: Specifies whether the alert scope is subscription
      type: object
    AzureLogAnalyticsWorkspaceDetails:
      properties:
        resource_id:
          type: string
          description: Resource Id
        name:
          type: string
          description: Workspace Name
        workspace_id:
          type: string
          description: Workspace Id
      type: object
  securitySchemes:
    auth_token:
      type: apiKey
      in: header
      name: X-Auth-Token