Cisco Identity Services Engine Network Access - Dictionaries API

openapi: 3.2.0
info:
  title: Cisco ISE API - Policy Network Access - Dictionaries 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 - Dictionaries
paths:
  /api/v1/policy/network-access/dictionaries:
    get:
      tags:
      - Network Access - Dictionaries
      summary: Network Access - Returns a list of Dictionaries.
      description: Get all Dictionaries.
      operationId: getNetworkAccessDictionaries
      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 containing DictionaryListResponseEntity object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryListResponseEntity'
                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 - Dictionaries
      summary: Network Access - Create a new Dictionary.
      description: Network Access - Create a new Dictionary.
      operationId: postNetworkAccessDictionaries
      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/Dictionary'
              exampleSetFlag: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryResponseEntity'
                exampleSetFlag: false
        '201':
          description: Response containing DictionaryResponseEntity object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryResponseEntity'
                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
        '409':
          description: Conflict in the current state of the resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                exampleSetFlag: false
      security:
      - BasicAuth: []
  /api/v1/policy/network-access/dictionaries/{name}:
    get:
      tags:
      - Network Access - Dictionaries
      summary: GET a dictionary by name
      description: GET a dictionary by name
      operationId: getNetworkAccessDictionary
      parameters:
      - name: name
        in: path
        description: the dictionary name
        required: true
        style: simple
        schema:
          type: string
          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 containing DictionaryResponseEntity object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryResponseEntity'
                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 - Dictionaries
      summary: Network Access - Update a Dictionary.
      description: Network Access - Update a Dictionary.
      operationId: putNetworkAccessDictionariesByName
      parameters:
      - name: name
        in: path
        description: the dictionary name
        required: true
        style: simple
        schema:
          type: string
          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/Dictionary'
              exampleSetFlag: false
      responses:
        '200':
          description: Response containing DictionaryResponseEntity object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryResponseEntity'
                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 - Dictionaries
      summary: Network Access - Delete a Dictionary.
      description: Network Access - Delete a Dictionary.
      operationId: deleteNetworkAccessDictionariesByName
      parameters:
      - name: name
        in: path
        description: the dictionary name
        required: true
        style: simple
        schema:
          type: string
          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 containing DictionaryResponseEntity object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DictionaryResponseEntity'
                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
    DictionaryListResponseEntity:
      title: DictionaryListResponseEntity
      required:
      - response
      - version
      type: object
      properties:
        response:
          type: array
          example: '[{"dictionaryAttrType":"ENTITY_ATTR","id":"12345678-f0e7-456b-a2d1-876543320b11","name":"my dictionary","description":"a dictionary description","link":{"rel":"self","href":"https://{{ISE_IP}}/api/v1/policy/{{protocol}}/dictionaries/ad947f38-7063-4da2-8723-652e0ca2ea41","type":"application/json"}}]'
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/Dictionary'
            exampleSetFlag: false
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      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
    Dictionary:
      title: Dictionary
      required:
      - dictionaryAttrType
      - name
      - version
      type: object
      properties:
        description:
          type: string
          description: The description of the Dictionary
          example: a dictionary description
          exampleSetFlag: true
        dictionaryAttrType:
          type: string
          description: The dictionary attribute type
          example: ENTITY_ATTR
          exampleSetFlag: true
          enum:
          - ENTITY_ATTR
          - MSG_ATTR
          - PIP_ATTR
        id:
          type: string
          description: Identifier for the dictionary
          format: uuid
          readOnly: true
          example: 12345678-f0e7-456b-a2d1-876543320b17
          exampleSetFlag: true
        link:
          $ref: '#/components/schemas/Link'
          exampleSetFlag: true
        name:
          type: string
          description: The dictionary name
          example: my dictionary
          exampleSetFlag: true
        version:
          type: string
          description: The dictionary version
          example: '1.2'
          exampleSetFlag: true
      description: Dictionary POST format
      exampleSetFlag: false
    DictionaryResponseEntity:
      title: DictionaryResponseEntity
      required:
      - response
      - version
      type: object
      properties:
        response:
          $ref: '#/components/schemas/Dictionary'
          exampleSetFlag: true
        version:
          type: string
          example: 1.0.0
          exampleSetFlag: true
      exampleSetFlag: false
  securitySchemes:
    BasicAuth:
      type: http
      description: Basic authorization
      scheme: basic