Cisco Identity Services Engine Network Access - Policy Sets API

openapi: 3.2.0
info:
  title: Cisco ISE API - Policy Network Access - Policy Sets 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.9.91:443
  description: Inferred Url
tags:
- name: Network Access - Policy Sets
paths:
  /api/v1/policy/network-access/policy-set:
    get:
      tags:
      - Network Access - Policy Sets
      summary: Network Access - List of policy sets.
      description: Get all network access policy sets.
      operationId: getNetworkAccessPolicySetList
      parameters:
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: List of network access policy sets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySetListResponseEntity'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
    post:
      tags:
      - Network Access - Policy Sets
      summary: Network Access - Create a new policy set.
      description: 'Network Access - Create a new policy set: <ul> <li> Policy must include name , service identifier (either server sequence or allowed protocol) and a condition. </li> <li> Condition has hierarchical structure which define a set of condition for which policy could be match. </li> <li> Condition can be either reference to a stored Library condition, using model <b>ConditionReference</b>, or, dynamically built conditions which are not stored in the conditions Library, using models <b>ConditionAttributes, ConditionAndBlock, ConditionOrBlock</b>.</li> </ul> '
      operationId: createNetworkAccessPolicySet
      parameters:
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicySet'
              exampleSetFlag: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySetResponseEntity'
                exampleSetFlag: false
        '201':
          description: PolicySet response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySetResponseEntity'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      security:
      - BasicAuth: []
  /api/v1/policy/network-access/policy-set/reset-hitcount:
    post:
      tags:
      - Network Access - Policy Sets
      summary: Network Access - Reset HitCount for PolicySets
      description: Network Access - Reset HitCount for PolicySets
      operationId: resetHitCountsNetworkAccessPolicySets
      parameters:
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Response with success message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponseEntity'
                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: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
  /api/v1/policy/network-access/policy-set/{policyId}:
    get:
      tags:
      - Network Access - Policy Sets
      summary: Network Access - Get policy set attributes.
      description: Network Access - Get policy set attributes.
      operationId: getNetworkAccessPolicySetById
      parameters:
      - name: policyId
        in: path
        description: Policy id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: PolicySet response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySetResponseEntity'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
    put:
      tags:
      - Network Access - Policy Sets
      summary: Network Access - Update a policy set.
      description: Network Access - Update a policy set.
      operationId: updateNetworkAccessPolicySetById
      parameters:
      - name: policyId
        in: path
        description: Policy id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicySet'
              exampleSetFlag: false
      responses:
        '200':
          description: PolicySet response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolicySetResponseEntity'
                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: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
    delete:
      tags:
      - Network Access - Policy Sets
      summary: Network Access - Delete a policy set.
      description: Network Access - Delete a policy set.
      operationId: deleteNetworkAccessPolicySetById
      parameters:
      - name: policyId
        in: path
        description: Policy id
        required: true
        style: simple
        schema:
          type: string
          format: uuid
          exampleSetFlag: true
      - name: X-Request-ID
        in: header
        description: request Id, will return in the response headers, and appear in logs
        required: false
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Response with object ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdResponseEntity'
                exampleSetFlag: false
        '204':
          description: No Content
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: The specified resource was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
components:
  schemas:
    Link:
      title: Link
      required:
      - href
      type: object
      properties:
        href:
          type: string
          example: https://{{ISE_IP}}/api/v1/policy/{{protocol}}/policy-set/{{resource-id}}
          exampleSetFlag: true
        rel:
          type: string
          example: self
          exampleSetFlag: true
          enum:
          - next
          - previous
          - self
          - status
        type:
          type: string
          example: application/json
          exampleSetFlag: true
      exampleSetFlag: false
    MessageResponseEntity:
      title: MessageResponseEntity
      required:
      - message
      type: object
      properties:
        message:
          type: string
          example: Success
          exampleSetFlag: true
      description: Response object containing success message
      exampleSetFlag: false
    IdResponseEntity:
      title: IdResponseEntity
      required:
      - id
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 07da6fd8-5abc-4dc4-bcec-df309dbf4d17
          exampleSetFlag: true
      description: response object containing object ID
      exampleSetFlag: false
    PolicySet:
      title: PolicySet
      required:
      - name
      - serviceName
      type: object
      properties:
        condition:
          $ref: '#/components/schemas/Condition'
          exampleSetFlag: true
        default:
          type: boolean
          description: Flag which indicates if this policy set is the default one
          readOnly: true
          example: true
          exampleSetFlag: true
        description:
          type: string
          description: The description for the policy set
          example: My Description
          exampleSetFlag: true
        hitCounts:
          type: integer
          description: The amount of times the policy was matched
          format: int32
          readOnly: true
          example: 5
          exampleSetFlag: true
        id:
          type: string
          description: Identifier for the policy set
          format: uuid
          readOnly: true
          example: 12345678-f0e7-456b-a2d1-876543320b14
          exampleSetFlag: true
        isProxy:
          type: boolean
          description: Flag which indicates if the policy set service is of type 'Proxy Sequence' or 'Allowed Protocols'
          example: false
          exampleSetFlag: true
        link:
          $ref: '#/components/schemas/Link'
          exampleSetFlag: true
        name:
          type: string
          description: Given name for the policy set, [Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses]
          example: My_policy_set 1
          exampleSetFlag: true
        rank:
          type: integer
          description: The rank(priority) in relation to other policy set. Lower rank is higher priority.
          format: int32
          example: 0
          exampleSetFlag: true
        serviceName:
          type: string
          description: Policy set service identifier - Allowed Protocols,Server Sequence..
          example: Default Network Access
          exampleSetFlag: true
        state:
          type: string
          description: The state that the policy set is in. A disabled policy set cannot be matched.
          example: enabled
          exampleSetFlag: true
          enum:
          - disabled
          - enabled
          - monitor
      description: Policy set structure
      exampleSetFlag: false
    Error:
      title: Error
      type: object
      properties:
        code:
          type: string
          example: '400'
          exampleSetFlag: true
        message:
          type: string
          example: Bad Request
          exampleSetFlag: true
      exampleSetFlag: false
    Condition:
      title: Condition
      required:
      - conditionType
      type: object
      properties:
        conditionType:
          type: string
          description: <ul><li>Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation</li> <li>Data type enum(reference,single) indicates than "conditonId" OR "ConditionAttrs" fields should contain condition data but not both</li> <li>Logical aggreation(and,or) enum indicates that additional conditions are present under the children field</li></ul>
          example: ConditionAttributes
          exampleSetFlag: true
          enum:
          - ConditionAndBlock
          - ConditionAttributes
          - ConditionOrBlock
          - ConditionReference
          - LibraryConditionAndBlock
          - LibraryConditionAttributes
          - LibraryConditionOrBlock
          - TimeAndDateCondition
        isNegate:
          type: boolean
          description: Indicates whereas this condition is in negate mode
          example: false
          exampleSetFlag: true
        link:
          $ref: '#/components/schemas/Link'
          exampleSetFlag: true
      description: <ul><li>Hierarchical structure which defines a set of conditions for which authentication or authorization policy rules could be matched.</li> <li>Logical operations(AND, OR) relationship between conditions are supported</li> <li>Each condition can have subconditions with relation to logical operations</li></ul>
      exampleSetFlag: false
    PolicySetResponseEntity:
      title: PolicySetResponseEntity
      required:
      - response
      - version
      type: object
      properties:
        response:
          $ref: '#/components/schemas/PolicySet'
          exampleSetFlag: true
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      exampleSetFlag: false
    PolicySetListResponseEntity:
      title: PolicySetListResponseEntity
      required:
      - response
      - version
      type: object
      properties:
        response:
          type: array
          example: '[{"default":false,"id":"793f55af-ad78-4021-bbdc-6286724394f8","name":"New Policy Set 1","description":null,"hitCounts":0,"rank":0,"state":"enabled","condition":{"link":null,"conditionType":"ConditionReference","isNegate":false,"name":"Switch_Local_Web_Authentication","id":"19d968b0-ebcb-4cdd-98e3-fe02e5521266","description":"A condition to match authentication requests for Local Web Authentication from Cisco Catalyst Switches"},"serviceName":"Default Network Access","isProxy":false,"link":{"rel":"self","href":"https://{{ISE_IP}}/api/v1/policy/{{protocol}}/policy-set/793f55af-ad78-4021-bbdc-6286724394f8","type":"application/json"}}]'
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/PolicySet'
            exampleSetFlag: false
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      exampleSetFlag: false
  securitySchemes:
    BasicAuth:
      type: http
      description: Basic authorization
      scheme: basic