Cisco Identity Services Engine User Equipment API

openapi: 3.2.0
info:
  title: Cisco ISE 5G User Equipment 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://{server}/v1/
  variables:
    server:
      default: localhost
      description: The host where the API is rooted
security:
- BasicAuth: []
tags:
- name: User Equipment
paths:
  /fiveg/user-equipment:
    get:
      summary: Get user equipments
      operationId: getUserEquipments
      tags:
      - User Equipment
      parameters:
      - $ref: ./api.yaml#/components/parameters/pageNumber
      - $ref: ./api.yaml#/components/parameters/pageSize
      - $ref: '#/components/parameters/XRequestIdHeader'
      - $ref: ./api.yaml#/components/parameters/filtering
      - $ref: ./api.yaml#/components/parameters/filtertype
      - $ref: ./api.yaml#/components/parameters/sortType
      - $ref: ./api.yaml#/components/parameters/sortBy
      responses:
        200:
          description: Fetched user equipments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEquipmentGetAllResponsePayload'
        400:
          $ref: ./api.yaml#/components/responses/BadRequest
        404:
          $ref: ./api.yaml#/components/responses/NotFound
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
    post:
      summary: Create a user equipment
      operationId: createUserEquipment
      tags:
      - User Equipment
      parameters:
      - $ref: '#/components/parameters/XRequestIdHeader'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserEquipmentCreateRequest'
      responses:
        201:
          description: User Equipment Created Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEquipmentResponsePayload'
        400:
          $ref: ./api.yaml#/components/responses/BadRequest
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
  /fiveg/user-equipment/{userEquipmentId}:
    get:
      summary: Get the user equipment for a given ID
      operationId: getUserEquipmentById
      tags:
      - User Equipment
      parameters:
      - $ref: '#/components/parameters/UserEquipmentIdParam'
      - $ref: '#/components/parameters/XRequestIdHeader'
      responses:
        200:
          description: Fetched user equipment for the given ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEquipmentResponsePayload'
        404:
          $ref: ./api.yaml#/components/responses/NotFound
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
    put:
      summary: Update the user equipment for a given ID and request payload
      operationId: updateUserEquipment
      tags:
      - User Equipment
      parameters:
      - $ref: '#/components/parameters/UserEquipmentIdParam'
      - $ref: '#/components/parameters/XRequestIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserEquipmentUpdateRequest'
      responses:
        200:
          description: User equipment updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEquipmentResponsePayload'
        404:
          $ref: ./api.yaml#/components/responses/NotFound
        400:
          $ref: ./api.yaml#/components/responses/BadRequest
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
        409:
          $ref: ./api.yaml#/components/responses/Conflict
    delete:
      summary: Delete the user equipment for a given ID
      operationId: deleteUserEquipment
      tags:
      - User Equipment
      parameters:
      - $ref: '#/components/parameters/UserEquipmentIdParam'
      - $ref: '#/components/parameters/XRequestIdHeader'
      responses:
        200:
          description: User Equipment Deleted Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        400:
          $ref: ./api.yaml#/components/responses/BadRequest
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
        204:
          $ref: ./api.yaml#/components/responses/NoContent
  /fiveg/user-equipment/subscriber/{subscriberId}:
    get:
      summary: Get user equipments associated with a subscriber GUID
      operationId: getUserEquipmentsBySubscriberId
      tags:
      - User Equipment
      parameters:
      - $ref: '#/components/parameters/SubscriberIdParam'
      - $ref: '#/components/parameters/XRequestIdHeader'
      responses:
        200:
          description: User equipments retrieved successfully for the given subscriber ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEquipmentsForSubscriberResponsePayload'
        400:
          $ref: ./api.yaml#/components/responses/BadRequest
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
  /fiveg/user-equipment/imei/{imei}:
    get:
      summary: Get a user equipment based on the IMEI
      operationId: getUserEquipmentByIMEI
      tags:
      - User Equipment
      parameters:
      - $ref: '#/components/parameters/IMEI'
      - $ref: '#/components/parameters/XRequestIdHeader'
      responses:
        200:
          description: User equipment retrieved successfully based on the IMEI
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserEquipmentResponsePayload'
        400:
          $ref: ./api.yaml#/components/responses/BadRequest
        404:
          $ref: ./api.yaml#/components/responses/NotFound
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
  /fiveg/user-equipment/csv:
    post:
      summary: Create user equipments from a CSV file
      operationId: createUserEquipmentsFromCSV
      tags:
      - User Equipment
      parameters:
      - $ref: '#/components/parameters/XRequestIdHeader'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                fileName:
                  type: string
                  format: binary
      responses:
        200:
          description: Subscriber Created Successfully
          $ref: '#/components/responses/TaskAccepted'
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
        400:
          $ref: ./api.yaml#/components/responses/BadRequest
  /fiveg/user-equipment/bulk:
    post:
      summary: Create, update and delete multiple user equipments
      operationId: bulkUserEquipmentOperation
      tags:
      - User Equipment
      parameters:
      - $ref: '#/components/parameters/XRequestIdHeader'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationsUE'
      responses:
        200:
          description: Subscriber Created Successfully
          $ref: '#/components/responses/TaskAccepted'
        500:
          $ref: ./api.yaml#/components/responses/InternalServerError
        400:
          $ref: ./api.yaml#/components/responses/BadRequest
components:
  schemas:
    Version:
      type: string
      pattern: ^[0-9]+(\.[0-9]+){2}$
      example: 1.0.0
    UserEquipmentsForSubscriberResponsePayload:
      type: object
      properties:
        response:
          type: array
          items:
            $ref: '#/components/schemas/UserEquipmentResponse'
        version:
          $ref: '#/components/schemas/Version'
    OperationsUE:
      type: object
      properties:
        operation:
          enum:
          - Create
          - Update
          - Delete
        ItemList:
          $ref: '#/components/schemas/UserEquipmentArray'
    UserEquipmentBulkRequest:
      type: object
      properties:
        imei:
          type: string
          example: '490154203237518'
        description:
          type: string
          example: Sample Description
        id:
          $ref: '#/components/schemas/UserEquipmentId'
        deviceGroup:
          type: string
          description: Device or Endpoint Group
          example: 7a9484cf-0ebc-47ad-a9ef-bc12729ed73f
    UserEquipmentArray:
      type: array
      items:
        $ref: '#/components/schemas/UserEquipmentBulkRequest'
    SubscriberId:
      type: string
      format: uuid
      example: 7c9484cf-0ebc-47ad-a9ef-bc12729ed73d
    UserEquipmentId:
      type: string
      format: uuid
      example: 7c9484cf-0ebc-47ad-a9ef-bc12729ed73b
    Timestamp:
      type: object
      properties:
        createTime:
          type: string
        updateTime:
          type: string
    GetAllResponseAttrs:
      type: object
      properties:
        nextPage:
          $ref: '#/components/schemas/Link'
        previousPage:
          $ref: '#/components/schemas/Link'
        version:
          $ref: '#/components/schemas/Version'
    Link:
      type: object
      properties:
        rel:
          enum:
          - next
          - previous
          - self
          - status
          type: string
          example: self
        href:
          type: string
          example: https://<ip>/api/v1/fiveg/<userEquipment/subscriber>/<ID>
        type:
          type: string
          example: application/json
    UserEquipment:
      allOf:
      - $ref: '#/components/schemas/UserEquipmentCreateRequest'
      - $ref: '#/components/schemas/Timestamp'
      - type: object
        properties:
          id:
            $ref: '#/components/schemas/UserEquipmentId'
    UserEquipmentCreateRequest:
      allOf:
      - $ref: '#/components/schemas/UserEquipmentUpdateRequest'
      - type: object
        required:
        - imei
        properties:
          imei:
            type: string
            description: IMEI for User Equipment
            example: '490154203237518'
            minLength: 14
            maxLength: 15
            pattern: ^[0-9]{14,15}$
    UserEquipmentGetAllResponsePayload:
      allOf:
      - type: object
        properties:
          response:
            type: array
            items:
              $ref: '#/components/schemas/UserEquipmentResponse'
      - $ref: '#/components/schemas/GetAllResponseAttrs'
    UserEquipmentResponsePayload:
      type: object
      properties:
        response:
          $ref: '#/components/schemas/UserEquipmentResponse'
        version:
          $ref: '#/components/schemas/Version'
    DeleteResponse:
      type: object
      properties:
        message:
          type: string
          example: Resource with ID 8d32371d-ee1a-47ce-995f-5966dec3c5dc was deleted successfully
    UserEquipmentResponse:
      allOf:
      - $ref: '#/components/schemas/UserEquipment'
      - type: object
        properties:
          link:
            $ref: '#/components/schemas/Link'
    UserEquipmentUpdateRequest:
      type: object
      properties:
        description:
          type: string
          description: Description for User Equipment
          example: User Equipment
        deviceGroup:
          type: string
          description: Device or Endpoint Group
          example: 7a9484cf-0ebc-47ad-a9ef-bc12729ed73f
  parameters:
    IMEI:
      name: imei
      in: path
      description: IMEI for the user equipment object
      required: true
      schema:
        type: string
        minLength: 14
        maxLength: 15
        pattern: ^[0-9]{14,15}$
      example: '490154203237518'
    XRequestIdHeader:
      in: header
      name: X-Request-ID
      description: The Request ID is returned in the response headers and appear in logs
      schema:
        type: string
      required: false
    SubscriberIdParam:
      name: subscriberId
      in: path
      description: Unique ID for a subscriber object
      required: true
      schema:
        $ref: '#/components/schemas/SubscriberId'
    UserEquipmentIdParam:
      name: userEquipmentId
      in: path
      description: Unique ID for a user equipment object
      required: true
      schema:
        $ref: '#/components/schemas/UserEquipmentId'
      example: 7c9484cf-0ebc-47ad-a9ef-bc12729ed73b
  responses:
    TaskAccepted:
      description: Task accepted ID can be used to track the task through the task API
      content:
        application/json:
          schema:
            $ref: ./api.yaml#/components/schemas/TaskResponse
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic