EntraApplicationsCopilotAgentExportSpec.yml

openapi: 3.0.4
info:
  title:
    Entra Workload ID Viewer API
  description: 
    This API provides endpoints to securely query and retrieve Workload Identity data from Microsoft Entra ID.
    Built on Azure Functions, the API enables to access information such as Workload IDs that are registered in own tenant or applications that are homed in another tenant.
  version: v1.0

paths:
  /api/sec-cop-entra-ea-az-func:
    get:
      description: |
        This agent retrieves a summary of Workload Identity details from Microsoft Entra ID using the Entra Workload ID Viewer Agent. Using this plugin, you can query and obtain information about Workload IDs registered in your tenant or those homed in other tenants.
      operationId: SummaryofWorkloadIDs
      parameters:
        - name: x-functions-key
          in: header
          schema:
            type: string
        - name: tenantId
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Request-Context:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  "Apps with an app registration in this tenant":
                    type: number
                  "Apps without an app registration in this tenant":
                    type: number
  
  /api/sec-cop-entra-ea-az-func-export:
    get:
      description: |
        This agent retrieves Workload Identity details from Microsoft Entra ID
        using the Entra Workload ID Viewer Agent. Using this plugin, you can
        query and obtain information like AppId, AppDisplayName, AppPublisherId
        etc. about Workload IDs registered in your tenant.
      operationId: ExportofWorkloadIDs
      parameters:
        - name: x-functions-key
          in: header
          schema:
            type: string
        - name: tenantId
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Request-Context:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: string
                    DisplayName:
                      type: string
                    AppOwnerOrganizationId:
                      type: string
  
  /api/sec-cop-entra-ea-az-func-secrets:
    get:
      description: |
        This agent connects to Microsoft Entra ID and retrieves all application client secrets from App Registrations. It reports the application name, App ID, secret ID, expiry date, and whether each secret is valid, expired, or nearing expiry. Applications without secrets are ignored, keeping the results focused on those that require monitoring and renewal.
      operationId: DiscoverEntraIDAppswithSecrets
      parameters:
        - name: x-functions-key
          in: header
          schema:
            type: string
        - name: tenantId
          in: header
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Request-Context:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    AppName:
                      type: string
                    AppId:
                      type: string
                    ExpiryDate:
                      type: string
                    Status:
                      type: string                    
x-ms-generated-by:
  toolName: Dev Proxy
  toolVersion: 1.1.0