APIs.io Engineering Platform Device Posture Integrations API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Device Posture Integrations API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Device Posture Integrations
paths:
  /accounts/{account_id}/devices/posture/integration:
    get:
      description: Fetches the list of device posture integrations for an account.
      operationId: device-posture-integrations-list-device-posture-integrations
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_schemas-response_collection'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: List your device posture integrations response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-response_collection'
          description: List your device posture integrations response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List your device posture integrations
      tags:
      - Device Posture Integrations
      x-api-token-group:
      - Teams Read
      - Teams Write
    post:
      description: Create a new device posture integration.
      operationId: device-posture-integrations-create-device-posture-integration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/teams-devices_config_request'
                interval:
                  $ref: '#/components/schemas/teams-devices_interval'
                name:
                  $ref: '#/components/schemas/teams-devices_components-schemas-name'
                type:
                  $ref: '#/components/schemas/teams-devices_schemas-type'
              required:
              - name
              - type
              - interval
              - config
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_schemas-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Create a device posture integration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-single_response'
          description: Create a device posture integration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a device posture integration
      tags:
      - Device Posture Integrations
      x-api-token-group:
      - Teams Write
  /accounts/{account_id}/devices/posture/integration/{integration_id}:
    delete:
      description: Delete a configured device posture integration.
      operationId: device-posture-integrations-delete-device-posture-integration
      parameters:
      - in: path
        name: integration_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_schemas-id_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Delete a device posture integration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-id_response'
          description: Delete a device posture integration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a device posture integration
      tags:
      - Device Posture Integrations
      x-api-token-group:
      - Teams Write
    get:
      description: Fetches details for a single device posture integration.
      operationId: device-posture-integrations-device-posture-integration-details
      parameters:
      - in: path
        name: integration_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_schemas-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Get device posture integration details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-single_response'
          description: Get device posture integration details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get device posture integration details
      tags:
      - Device Posture Integrations
      x-api-token-group:
      - Teams Read
      - Teams Write
    patch:
      description: Updates a configured device posture integration.
      operationId: device-posture-integrations-update-device-posture-integration
      parameters:
      - in: path
        name: integration_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/teams-devices_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/teams-devices_config_request'
                interval:
                  $ref: '#/components/schemas/teams-devices_interval'
                name:
                  $ref: '#/components/schemas/teams-devices_components-schemas-name'
                type:
                  $ref: '#/components/schemas/teams-devices_schemas-type'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/teams-devices_schemas-single_response'
                - $ref: '#/components/schemas/teams-devices_api-response-common-failure'
          description: Update a device posture integration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teams-devices_schemas-single_response'
          description: Update a device posture integration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a device posture integration
      tags:
      - Device Posture Integrations
      x-api-token-group:
      - Teams Write
components:
  schemas:
    teams-devices_crowdstrike_config_request:
      properties:
        api_url:
          description: The Crowdstrike API URL.
          example: https://api.us-2.crowdstrike.com
          type: string
        client_id:
          description: The Crowdstrike client ID.
          example: example client id
          type: string
        client_secret:
          description: The Crowdstrike client secret.
          example: example client secret
          type: string
        customer_id:
          description: The Crowdstrike customer ID.
          example: example customer id
          type: string
      required:
      - api_url
      - customer_id
      - client_id
      - client_secret
      title: Crowdstrike Config
      type: object
    teams-devices_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    teams-devices_schemas-type:
      description: The type of device posture integration.
      enum:
      - workspace_one
      - crowdstrike_s2s
      - uptycs
      - intune
      - kolide
      - tanium
      - sentinelone_s2s
      - custom_s2s
      example: workspace_one
      type: string
    teams-devices_custom_s2s_config_request:
      properties:
        access_client_id:
          description: This id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`
          example: 88bf3b6d86161464f6509f7219099e57.access
          type: string
        access_client_secret:
          description: This secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`
          example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5
          type: string
        api_url:
          description: The Custom Device Posture Integration  API URL.
          example: https://example.custom-s2s.com
          type: string
      required:
      - api_url
      - access_client_id
      - access_client_secret
      title: Custom Device Posture Integration Config
      type: object
    teams-devices_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/teams-devices_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/teams-devices_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    teams-devices_uuid:
      description: API UUID.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    teams-devices_components-schemas-name:
      description: The name of the device posture integration.
      example: My Workspace One Integration
      type: string
    teams-devices_tanium_config_request:
      properties:
        access_client_id:
          description: If present, this id will be passed in the `CF-Access-Client-ID` header when hitting the `api_url`
          example: 88bf3b6d86161464f6509f7219099e57.access
          type: string
        access_client_secret:
          description: If present, this secret will be passed in the `CF-Access-Client-Secret` header when hitting the `api_url`
          example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5
          type: string
        api_url:
          description: The Tanium API URL.
          example: https://dummy-tanium-api.cloudflare.com/plugin/products/gateway/graphql
          type: string
        client_secret:
          description: The Tanium client secret.
          example: example client secret
          type: string
      required:
      - api_url
      - client_secret
      title: Tanium Config
      type: object
    teams-devices_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-common'
      - properties:
          result:
            items: {}
            nullable: true
            type: array
          result_info:
            $ref: '#/components/schemas/teams-devices_result_info'
      type: object
    teams-devices_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/teams-devices_messages'
        messages:
          $ref: '#/components/schemas/teams-devices_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful.
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    teams-devices_identifier:
      example: 699d98642c564d2e855e9661899b7252
    teams-devices_schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-single'
      - properties:
          result:
            nullable: true
            type: object
    teams-devices_schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/teams-devices_device-posture-integrations'
            type: array
    teams-devices_interval:
      description: The interval between each posture check with the third-party API. Use `m` for minutes (e.g. `5m`) and `h` for hours (e.g. `12h`).
      example: 10m
      type: string
    teams-devices_sentinelone_s2s_config_request:
      properties:
        api_url:
          description: The SentinelOne S2S API URL.
          example: https://example.sentinelone.net
          type: string
        client_secret:
          description: The SentinelOne S2S client secret.
          example: example client secret
          type: string
      required:
      - api_url
      - client_secret
      title: SentinelOne S2S Config
      type: object
    teams-devices_schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/teams-devices_device-posture-integrations'
    teams-devices_device-posture-integrations:
      properties:
        config:
          $ref: '#/components/schemas/teams-devices_config_response'
        id:
          $ref: '#/components/schemas/teams-devices_uuid'
        interval:
          $ref: '#/components/schemas/teams-devices_interval'
        name:
          $ref: '#/components/schemas/teams-devices_components-schemas-name'
        type:
          $ref: '#/components/schemas/teams-devices_schemas-type'
      type: object
    teams-devices_uptycs_config_request:
      properties:
        api_url:
          description: The Uptycs API URL.
          example: rnd.uptycs.io
          type: string
        client_key:
          description: The Uptycs client secret.
          example: example client key
          type: string
        client_secret:
          description: The Uptycs client secret.
          example: example client secret
          type: string
        customer_id:
          description: The Uptycs customer ID.
          example: example customer id
          type: string
      required:
      - api_url
      - client_key
      - customer_id
      - client_secret
      title: Uptycs Config
      type: object
    teams-devices_intune_config_request:
      properties:
        client_id:
          description: The Intune client ID.
          example: example client id
          type: string
        client_secret:
          description: The Intune client secret.
          example: example client secret
          type: string
        customer_id:
          description: The Intune customer ID.
          example: example customer id
          type: string
      required:
      - customer_id
      - client_id
      - client_secret
      title: Intune Config
      type: object
    teams-devices_api-response-single:
      allOf:
      - $ref: '#/components/schemas/teams-devices_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            nullable: true
            type: object
      type: object
    teams-devices_workspace_one_config_request:
      properties:
        api_url:
          description: The Workspace One API URL provided in the Workspace One Admin Dashboard.
          example: https://as123.awmdm.com/API
          type: string
        auth_url:
          description: The Workspace One Authorization URL depending on your region.
          example: https://na.uemauth.vmwservices.com/connect/token
          type: string
        client_id:
          description: The Workspace One client ID provided in the Workspace One Admin Dashboard.
          example: example client id
          type: string
        client_secret:
          description: The Workspace One client secret provided in the Workspace One Admin Dashboard.
          example: example client secret
          type: string
      required:
      - api_url
      - auth_url
      - client_id
      - client_secret
      title: Workspace One Config
      type: object
    teams-devices_config_request:
      description: The configuration object containing third-party integration information.
      example:
        api_url: https://as123.awmdm.com/API
        auth_url: https://na.uemauth.vmwservices.com/connect/token
        client_id: example client id
        client_secret: example client secret
      oneOf:
      - $ref: '#/components/schemas/teams-devices_workspace_one_config_request'
      - $ref: '#/components/schemas/teams-devices_crowdstrike_config_request'
      - $ref: '#/components/schemas/teams-devices_uptycs_config_request'
      - $ref: '#/components/schemas/teams-devices_intune_config_request'
      - $ref: '#/components/schemas/teams-devices_kolide_config_request'
      - $ref: '#/components/schemas/teams-devices_tanium_config_request'
      - $ref: '#/components/schemas/teams-devices_sentinelone_s2s_config_request'
      - $ref: '#/components/schemas/teams-devices_custom_s2s_config_request'
      type: object
    teams-devices_kolide_config_request:
      properties:
        client_id:
          description: The Kolide client ID.
          example: example client id
          type: string
        client_secret:
          description: The Kolide client secret.
          example: example client secret
          type: string
      required:
      - client_id
      - client_secret
      title: Kolide Config
      type: object
    teams-devices_workspace_one_config_response:
      description: The Workspace One Config Response.
      properties:
        api_url:
          description: The Workspace One API URL provided in the Workspace One Admin Dashboard.
          example: https://as123.awmdm.com/API
          type: string
        auth_url:
          description: The Workspace One Authorization URL depending on your region.
          example: https://na.uemauth.vmwservices.com/connect/token
          type: string
        client_id:
          description: The Workspace One client ID provided in the Workspace One Admin Dashboard.
          example: example client id
          type: string
      required:
      - api_url
      - auth_url
      - client_id
      type: object
    teams-devices_config_response:
      description: The configuration object containing third-party integration information.
      example:
        api_url: https://as123.awmdm.com/API
        auth_url: https://na.uemauth.vmwservices.com/connect/token
        client_id: example client id
      oneOf:
      - $ref: '#/components/schemas/teams-devices_workspace_one_config_response'
      type: object
    teams-devices_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true