Cisco Identity Services Engine Workload Connection API

openapi: 3.2.0
info:
  title: Cisco ISE API - TrustSec Workload Connection API
  version: 1.0.0
  x-provenance:
    method: harvested
    authored_by: Cisco
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: pubhub.devnetcloud.com
    note: 103 ISE API descriptions (1,490 operations; 32 OpenAPI 3.0.x + 71 Swagger 2.0) enumerated from Cisco's own DevNet project manifest and fetched anonymously. Byte-identity reconfirmed 2026-08-19 by SHA-256 against the live source.
  x-evidence:
  - type: source
    url: https://pubhub.devnetcloud.com/media/identity-services-engine-api-v1/docs/
  - type: source
    url: https://developer.cisco.com/docs/identity-services-engine/
servers:
- url: https://172.23.118.207:443
  description: Inferred Url
tags:
- name: Workload Connection
paths:
  /api/v1/trustsec/inbound-rule/previewMappingCount:
    get:
      tags:
      - Workload Connection
      summary: Returns a count of total number of inbound rule mappings
      description: count of total number of inbound rule mappings.
      operationId: getPreviewMappingCount
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Returns a count of total number of inbound rule mappings
          content:
            application/json:
              schema:
                type: integer
                format: int32
                exampleSetFlag: true
        '400':
          description: Bad Request for this specified resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection:
    get:
      tags:
      - Workload Connection
      summary: Get all workload connections
      description: List all the workload connections configured.
      operationId: getCloudConnections
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Workload Connection information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudConnectionSummaryListResponseEntity'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/attribute:
    get:
      tags:
      - Workload Connection
      summary: Get attributes for all connectors
      operationId: getAttributesForAllConnectors
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Attributes from all workload connections
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllAttributesMappingResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/attribute/values/{connectionType}/{attributeName}:
    get:
      tags:
      - Workload Connection
      summary: Get the values of an attribute
      operationId: getAttributeValues
      parameters:
      - name: connectionType
        in: path
        description: External Connection Type
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
          enum:
          - '"AWS"'
          - '"AZURE"'
          - '"GCP"'
          - '"VCENTER"'
      - name: attributeName
        in: path
        description: Attribute name in dictionary
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Attribute values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttributeValuesResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/attribute/{connectionType}:
    get:
      tags:
      - Workload Connection
      summary: Get attributes for all connectors of a specific type
      operationId: getAttributesForConnectorsByType
      parameters:
      - name: connectionType
        in: path
        description: External Connection Type
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
          enum:
          - '"AWS"'
          - '"AZURE"'
          - '"GCP"'
          - '"VCENTER"'
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Attributes from all workload connections of a specific type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchAttributeMappingResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
      - Workload Connection
      summary: Perform the required crud operations given a list of all attributes of a specific type
      description: Updates the attribute
      operationId: updateAttributesByType
      parameters:
      - name: connectionType
        in: path
        description: External Connection Type
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
          enum:
          - '"AWS"'
          - '"AZURE"'
          - '"GCP"'
          - '"VCENTER"'
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              type: array
              exampleSetFlag: true
              items:
                $ref: '#/components/schemas/AttributeMapping'
                exampleSetFlag: false
      responses:
        '200':
          description: Update of attributes
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '201':
          description: Created
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/aws:
    post:
      tags:
      - Workload Connection
      summary: Create an AWS connection.
      description: Create an AWS connection.
      operationId: createAWSConnection
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsConfigWithAttribute'
              exampleSetFlag: false
      responses:
        '200':
          description: Created connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsConfigResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/aws/attribute/fetch:
    post:
      tags:
      - Workload Connection
      summary: Get Attributes list from AWS
      description: Get Attributes list from AWS connection.
      operationId: getAttributesFromAWS
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsAccessInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: Attributes response list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchAttributeMappingResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/aws/test:
    post:
      tags:
      - Workload Connection
      summary: Test the AWS Connection
      description: AWS connection - test the connection.
      operationId: testAWSConnector
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsAccessInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: Test connection is successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/aws/{connectionId}:
    get:
      tags:
      - Workload Connection
      summary: Returns AWS connection details.
      description: Returns AWS connection details.
      operationId: getAWSConnectionByID
      parameters:
      - name: connectionId
        in: path
        description: Unique id for the Workload Connection
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Connection information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsConfigResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
      - Workload Connection
      summary: Edit an AWS connection.
      description: Edit an AWS connection.
      operationId: updateAWSConnectionByID
      parameters:
      - name: connectionId
        in: path
        description: Unique id for the Workload Connection
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AwsConfig'
              exampleSetFlag: false
      responses:
        '200':
          description: Updated connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsConfigResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/azure:
    post:
      tags:
      - Workload Connection
      summary: Create an Azure connection
      description: Create an Azure connection.
      operationId: createAzureConnection
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureConfigWithAttribute'
              exampleSetFlag: false
      responses:
        '200':
          description: Created connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureConfigResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/azure/attribute/fetch:
    post:
      tags:
      - Workload Connection
      summary: Get Attributes list from Azure
      description: Get Attributes list from Azure connection.
      operationId: getAttributesFromAzure
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureAccessInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: Attributes response list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchAttributeMappingResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/azure/test:
    post:
      tags:
      - Workload Connection
      summary: Test the Azure Connection
      description: Azure connection - test the connection.
      operationId: testAzureConnector
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureAccessInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: Test connection is successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/azure/{connectionId}:
    get:
      tags:
      - Workload Connection
      summary: Returns the Azure connection
      description: Returns the Azure connection.
      operationId: getAzureConnectionByID
      parameters:
      - name: connectionId
        in: path
        description: Unique id for the Workload Connection
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Azure connection information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureConfigResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
      - Workload Connection
      summary: Update an Azure connection
      description: Update an Azure connection.
      operationId: updateAzureConnectionByID
      parameters:
      - name: connectionId
        in: path
        description: Unique id for the Workload Connection
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AzureConfig'
              exampleSetFlag: false
      responses:
        '200':
          description: Updated connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureConfigResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/fetch-new-attributes/{connectionId}:
    get:
      tags:
      - Workload Connection
      summary: Fetch the new attributes from an workload connection
      operationId: fetchNewAttributes
      parameters:
      - name: connectionId
        in: path
        description: Unique id for the Workload Connection
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: New attributes fetched for the connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchAttributeMappingResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/gcp:
    post:
      tags:
      - Workload Connection
      summary: Create a GCP connection.
      description: Create a GCP connection.
      operationId: createGCPConnection
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GcpConfigWithAttribute'
              exampleSetFlag: false
      responses:
        '200':
          description: Created connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GcpConfigResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/gcp/attribute/fetch:
    post:
      tags:
      - Workload Connection
      summary: Get Attributes list from GCP
      description: Get Attributes list from GCP connection.
      operationId: getAttributesFromGCP
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GcpAccessInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: Attributes response list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FetchAttributeMappingResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/gcp/test:
    post:
      tags:
      - Workload Connection
      summary: Test the GCP Connection
      description: GCP connection - test the connection.
      operationId: testGCPConnector
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GcpAccessInfo'
              exampleSetFlag: false
      responses:
        '200':
          description: Test connection is successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/gcp/{connectionId}:
    get:
      tags:
      - Workload Connection
      summary: Returns a GCP connection details.
      description: Returns a GCP connection details.
      operationId: getGCPConnectionByID
      parameters:
      - name: connectionId
        in: path
        description: Unique id for the Workload Connection
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: GCP connection information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GcpConfigResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
    put:
      tags:
      - Workload Connection
      summary: Edit a GCP connection.
      description: Edit a GCP connection.
      operationId: updateGCPConnectionByID
      parameters:
      - name: connectionId
        in: path
        description: Unique id for the Workload Connection
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GcpConfig'
              exampleSetFlag: false
      responses:
        '200':
          description: Updated connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GcpConfigResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/names:
    get:
      tags:
      - Workload Connection
      summary: Get all workload connection names
      description: List all the workload connection names configured.
      operationId: getWorkloadConnectionNames
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Workload Connection names
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadConnectionNamesResponseEntity'
                exampleSetFlag: false
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/services/start:
    post:
      tags:
      - Workload Connection
      summary: Start the workload connector services
      description: Start the workload connector services
      operationId: startWorkloadConnectorServices
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Starting the workload connector services.
          content:
            application/json:
              schema:
                $ref: Error-ModelName{namespace='java.lang', name='Void'}
                exampleSetFlag: false
        '201':
          description: Created
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/services/status:
    get:
      tags:
      - Workload Connection
      summary: Returns status of workload connector services
      description: Get the status of workload connector services
      operationId: getWorkloadConnectorServicesStatus
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Returns the status of the services
          content:
            application/json:
              schema:
                type: string
                exampleSetFlag: true
        '400':
          description: Bad Request for this specified resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
  /api/v1/trustsec/integration/workload-connection/services/threshold:
    get:
      tags:
      - Workload Connection
      summary: Returns a dynamic count of new workload connections allowed along with the hardware profile of ISE
      description: Based on the memory usage, returns the number of new workload connections allowed along with the hardware profile of ISE.
      operationId: getWorkloadConnectorThreshold
      parameters:
      - name: X-Request-ID
        in: header
        description: The request ID header consists of the request ID which is returned in the response headers and also appears in the API service logs.
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Returns the count of new workload connections allowed and the hardware profile of ISE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkloadConnectorThresholdResponseEntity'
                exampleSetFlag: false
        '400':
          description: Bad Request for this specified resource
          content:
            application/json:
              sch

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-ise/refs/heads/main/openapi/cisco-ise-workload-connection-api-openapi.yml