Cisco Identity Services Engine Admin Users API

openapi: 3.2.0
info:
  title: Cisco ISE API - Rbac Catalog Admin Users 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://10.86.189.217:443
  description: Inferred Url
tags:
- name: Admin Users
paths:
  /api/v1/rbac/admin-user:
    get:
      tags:
      - Admin Users
      summary: Retrieve all admin users created in Cisco ISE
      description: Get admin users API will be used to view Cisco ISE administrators
      operationId: listAllAdminUsers
      parameters:
      - name: page
        in: query
        description: Page number
        required: false
        style: form
        schema:
          type: integer
          format: int32
          exampleSetFlag: true
      - name: size
        in: query
        description: Number of objects returned per page
        required: false
        style: form
        schema:
          type: integer
          format: int32
          exampleSetFlag: true
      - name: sort
        in: query
        description: sort type - asc or desc
        required: false
        style: form
        schema:
          type: string
          exampleSetFlag: true
          enum:
          - asc
          - desc
      - name: sortBy
        in: query
        description: sort column by which objects needs to be sorted
        required: false
        style: form
        schema:
          type: string
          exampleSetFlag: true
      - name: filter
        in: query
        description: '<div> <style type="text/css" scoped> .apiServiceTable td, .apiServiceTable th { padding: 5px 10px !important; text-align: left; } </style> <span> <b>Simple filtering</b> should be available through the filter query string parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the <i>"filterType=or"</i> query string parameter. Each resource Data model description should specify if an attribute is a filtered field. </span> <br /> <table class="apiServiceTable"> <thead> <tr> <th>OPERATOR</th> <th>DESCRIPTION</th> </tr> </thead> <tbody> <tr> <td>EQ</td> <td>Equals</td> </tr> <tr> <td>NEQ</td> <td>Not Equals</td> </tr> <tr> <td>GT</td> <td>Greater Than</td> </tr> <tr> <td>LT</td> <td>Less Then</td> </tr> <tr> <td>STARTSW</td> <td>Starts With</td> </tr> <tr> <td>NSTARTSW</td> <td>Not Starts With</td> </tr> <tr> <td>ENDSW</td> <td>Ends With</td> </tr> <tr> <td>NENDSW</td> <td>Not Ends With</td> </tr> <tr> <td>CONTAINS</td> <td>Contains</td> </tr> <tr> <td>NCONTAINS</td> <td>Not Contains</td> </tr> </tbody> </table> </div>'
        required: false
        style: form
        explode: true
        schema:
          type: string
          exampleSetFlag: true
      - name: filterType
        in: query
        description: The logical operator common to ALL filter criteria will be by default AND, and can be changed by using the parameter
        required: false
        style: form
        schema:
          type: string
          exampleSetFlag: true
          enum:
          - AND
          - OR
      responses:
        '200':
          description: A paged array of admin users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminUserResponse'
                exampleSetFlag: false
        '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
      security:
      - BasicAuth: []
    post:
      tags:
      - Admin Users
      summary: Create admin user in Cisco ISE
      description: Post admin users API will be used to create Cisco ISE administrators <ul> <li><strong>rbacGroups</strong> - ISE UI doesn't allow Read Only Admin group to be passed as Admin group in Admin user creation. Associating this Admin group will make Admin user read only. To make user as read only , enable readonly field as true.</li> <ul>
      operationId: createAdminUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiAdminUser'
              exampleSetFlag: false
      responses:
        '200':
          description: Added admin user successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: User already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '500':
          description: Internal server error
      security:
      - BasicAuth: []
  /api/v1/rbac/admin-user/bulk:
    post:
      tags:
      - Admin Users
      summary: Create multiple admin users in Cisco ISE
      description: Create bulk admin users API will be used to create multiple Cisco ISE administrators
      operationId: createBulkAdminUsers
      requestBody:
        content:
          application/json:
            schema:
              type: array
              exampleSetFlag: true
              items:
                $ref: '#/components/schemas/OpenApiAdminUser'
                exampleSetFlag: false
      responses:
        '200':
          description: Admin users created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '207':
          description: Admin users partially created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Admin users not found
      security:
      - BasicAuth: []
  /api/v1/rbac/admin-user/{name}:
    get:
      tags:
      - Admin Users
      summary: Get details of a requested admin user in Cisco ISE
      description: Get admin user API will be used to view requested Cisco ISE administrator details
      operationId: getAdminUserByName
      parameters:
      - name: name
        in: path
        description: The name of the admin user
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminUserDetailsResponse'
                exampleSetFlag: false
        '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
      security:
      - BasicAuth: []
    put:
      tags:
      - Admin Users
      summary: Update details of an admin user in Cisco ISE
      description: Put admin user API will be used to update details of  Cisco ISE administrators <ul> <li><strong>rbacGroups</strong> - ISE UI doesn't allow Read Only Admin group to be passed as Admin group in Admin user updation. Associating this Admin group will make Admin user read only. To make user as read only , enable readonly field as true.</li> <ul>
      operationId: updateAdminUser
      parameters:
      - name: name
        in: path
        description: The name of the admin user
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiAdminUser'
              exampleSetFlag: false
      responses:
        '200':
          description: Updated admin user successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Admin user not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
      security:
      - BasicAuth: []
    delete:
      tags:
      - Admin Users
      summary: Delete requested admin user available in Cisco ISE
      description: Delete admin user API will be used to delete available Cisco ISE administrator
      operationId: deleteAdminUser
      parameters:
      - name: name
        in: path
        description: The name of the admin user
        required: true
        style: simple
        schema:
          type: string
          exampleSetFlag: true
      responses:
        '200':
          description: Admin user deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '204':
          description: No Content
        '400':
          description: Admin user passed is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Admin user not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
                exampleSetFlag: false
      security:
      - BasicAuth: []
  /api/v1/rbac/network-users:
    get:
      tags:
      - Admin Users
      summary: Retrieve all external network users available in Cisco ISE
      description: Get external users API will be used to view Cisco ISE network external groups.
      operationId: listAllNetworkUsers
      responses:
        '200':
          description: Response object with all the external network users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalUserResponse'
                exampleSetFlag: false
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalUserResponse'
                exampleSetFlag: false
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalUserResponse'
                exampleSetFlag: false
      security:
      - BasicAuth: []
components:
  schemas:
    ExternalUserResponse:
      title: ExternalUserResponse
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: integer
          description: Status code of the response.
          format: int32
          exampleSetFlag: true
        message:
          type: string
          description: Message describing the response status.
          exampleSetFlag: true
        networkUsers:
          type: array
          description: List of network users in the response.
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/NetworkUser'
            exampleSetFlag: false
        totalCount:
          type: integer
          description: Total number of network users.
          format: int32
          exampleSetFlag: true
      description: Schema for the response containing external user data, including status code, message, and a list of network users.
      exampleSetFlag: false
    AdminUserResponse:
      title: AdminUserResponse
      required:
      - statusCode
      type: object
      properties:
        adminUserList:
          type: array
          description: A list of admin users.
          exampleSetFlag: true
          items:
            $ref: '#/components/schemas/AdminUserData'
            exampleSetFlag: false
        message:
          type: string
          description: A descriptive message related to the response.
          exampleSetFlag: true
        statusCode:
          type: integer
          description: The status code of the response.
          format: int32
          exampleSetFlag: true
      description: Response schema for admin user data, including the status code, message, and a list of admin user data.
      exampleSetFlag: false
    TaskResponse:
      title: TaskResponse
      type: object
      properties:
        id:
          type: string
          exampleSetFlag: true
      exampleSetFlag: false
    AdminUserData:
      title: AdminUserData
      required:
      - name
      type: object
      properties:
        description:
          type: string
          description: Description or role of the admin user.
          exampleSetFlag: true
        emailAddr:
          type: string
          description: Email address of the admin user.
          exampleSetFlag: true
        firstName:
          type: string
          description: First name of the admin user.
          exampleSetFlag: true
        id:
          type: string
          description: Unique identifier for the admin user.
          exampleSetFlag: true
        lastName:
          type: string
          description: Last name of the admin user.
          exampleSetFlag: true
        name:
          type: string
          description: Name of the admin user.
          exampleSetFlag: true
        rbacGroupNames:
          type: array
          description: List of RBAC group names the admin user belongs to.
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        statusEnabled:
          type: boolean
          description: Indicates whether the admin user's account is enabled.
          example: false
          exampleSetFlag: true
      description: Schema for admin user data, representing key information such as user details, email, and RBAC group memberships.
      exampleSetFlag: false
    Error:
      title: Error
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: integer
          description: The error code associated with the response. A non-zero code typically indicates an error.
          format: int32
          exampleSetFlag: true
        message:
          type: string
          description: A description of the error encountered.
          exampleSetFlag: true
      description: 'The `Error` object represents an error response. It provides information about  the error code and a message that explains the cause of the error. This object is typically returned when a request fails due to invalid input,  server issues, or other unforeseen circumstances. '
      exampleSetFlag: false
    AdminUserDetailsResponse:
      title: AdminUserDetailsResponse
      required:
      - statusCode
      type: object
      properties:
        adminUserDetails:
          $ref: '#/components/schemas/OpenApiAdminUser'
          exampleSetFlag: true
        message:
          type: string
          description: A message providing more information about the response.
          exampleSetFlag: true
        statusCode:
          type: integer
          description: The status code of the response.
          format: int32
          exampleSetFlag: true
      description: Response schema for retrieving detailed information about a specific admin user.
      exampleSetFlag: false
    NetworkUser:
      title: NetworkUser
      required:
      - name
      type: object
      properties:
        changePasswordOnNextLogin:
          type: boolean
          description: Indicates if the user should change their password on the next login.
          example: false
          exampleSetFlag: true
        description:
          type: string
          description: A description of the network user.
          exampleSetFlag: true
        email:
          type: string
          description: Email address of the network user.
          exampleSetFlag: true
        firstName:
          type: string
          description: The first name of the network user.
          exampleSetFlag: true
        inactiveAccountNeverDisabled:
          type: boolean
          description: Indicates if inactive accounts are never disabled.
          example: false
          exampleSetFlag: true
        lastName:
          type: string
          description: The last name of the network user.
          exampleSetFlag: true
        name:
          type: string
          description: The name of the network user.
          exampleSetFlag: true
        status:
          type: boolean
          description: Indicates whether the user account is active or not.
          example: false
          exampleSetFlag: true
      description: Schema representing a Network User. It includes details like name, email, password, and status. These users are typically restricted to specific network access.
      exampleSetFlag: false
    BaseResponse:
      title: BaseResponse
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: integer
          description: The response status code. A code of 0 typically indicates success, while non-zero codes represent errors or issues.
          format: int32
          exampleSetFlag: true
        message:
          type: string
          description: A message detailing the response, indicating success or failure.
          exampleSetFlag: true
      description: 'The `BaseResponse` object represents the standard structure for a response.  It contains a `code` indicating the success or failure of the request, and a  `message` providing additional details about the outcome. A `code` of `0` typically indicates a successful operation, whereas non-zero  values represent various types of errors or issues. '
      exampleSetFlag: false
    OpenApiAdminUser:
      title: OpenApiAdminUser
      required:
      - name
      type: object
      properties:
        changePasswordOnNextLogin:
          type: boolean
          description: Indicates if the user should change their password on the next login.
          example: false
          exampleSetFlag: true
        description:
          type: string
          description: A description of the admin user.
          exampleSetFlag: true
        email:
          type: string
          description: Email address of the admin user.
          exampleSetFlag: true
        external:
          type: boolean
          description: Indicates if the user is an external user.
          example: false
          exampleSetFlag: true
        firstName:
          type: string
          description: The first name of the admin user.
          exampleSetFlag: true
        inactiveAccountNeverDisabled:
          type: boolean
          description: Indicates if inactive accounts are never disabled.
          example: false
          exampleSetFlag: true
        includeSystemAlarmsInEmails:
          type: boolean
          description: Indicates if system alarms are included in the user's email notifications.
          example: false
          exampleSetFlag: true
        lastName:
          type: string
          description: The last name of the admin user.
          exampleSetFlag: true
        name:
          type: string
          description: The name of the admin user.
          exampleSetFlag: true
        password:
          type: string
          description: Password for the admin user.
          exampleSetFlag: true
        rbacGroups:
          type: array
          description: A list of RBAC groups the admin user belongs to.
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
        readOnly:
          type: boolean
          description: Indicates if the user has read-only permissions.
          example: false
          exampleSetFlag: true
        status:
          type: boolean
          description: Indicates whether the user account is active or not.
          example: false
          exampleSetFlag: true
      description: Schema representing an Admin User in the system. This includes attributes like user details, access control, and system-related settings.
      exampleSetFlag: false