Cisco Identity Services Engine
Cisco Identity Services Engine Identitygroups API

The identitygroups API from Cisco Identity Services Engine — 4 operation(s) for identitygroups.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.2.0
info:
  description: "Identity Groups API allows the client to search identity groups.  \n\n<h2>Revision History</h2>\n<table font-family:monospace> \n<tr valign=top style='border:solid #CCCCCC 1.0pt;mso-border-alt:solid #CCCCCC .75pt;background:#DEEDF7'><td><b>Revision #</b></td><td><b>Resource Version</b></td><td><b>Cisco ISE Version</b></td><td><b>Description</b></td></tr>\n<tr><td>0</td><td>1.0</td><td>2.2</td><td>Initial Cisco ISE Version</td></tr>\n<tr style='background:#f8f8f8'><td>1</td><td>1.1</td><td>2.4</td><td>Added Create and GetByName operations</td></tr>\n<tr style='border-bottom:solid #CCCCCC 1.0pt'><td>2</td><td>1.2</td><td>3.2</td><td>Added Patch operation</td></tr>\n<tr style='border-bottom:solid #CCCCCC 1.0pt'><td>3</td><td>1.3</td><td>3.2</td><td>Added Delete operation</td></tr>\n</table>\n<br><br>\n\n<h2>Resource Definition</h2>\n<table>\n<tr valign=top style='border:solid #CCCCCC 1.0pt;mso-border-alt:solid #CCCCCC .75pt;background:#DEEDF7'><td><b>Attribute</b></td><td><b>Type</b></td><td><b>Required</b></td><td><b>Description</b></td><td><b>Example Values</b></td></tr>\n<tr><td style='font-family:monospace'>name</td><td>String</td><td>Yes</td><td>Resource Name</td><td>GuestType_Weekly (default)</td></tr>\n<tr valign=top style='background:#f8f8f8'><td style='font-family:monospace'>id</td><td>String</td><td>No</td><td>Resource UUID, mandatory for update</td><td>9efe2310-8c01-11e6-996c-525400b48521</td></tr>\n<tr><td style='font-family:monospace'>description</td><td>String</td><td>No</td><td>Resource Description</td><td>Identity group mirroring the guest type</td></tr>\n<tr style= 'border-bottom:solid #CCCCCC 1.0pt; background:#f8f8f8'><td style='font-family:monospace'>parent</td><td>String</td><td>Yes</td><td></td><td>NAC Group:NAC:IdentityGroups:User Identity Groups</td></tr>\n</table>\n"
  version: 1.0.0
  title: Identity Groups Identitygroups API
  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/
tags:
- name: identitygroups
paths:
  /ers/config/identitygroup/name/{name}:
    get:
      tags:
      - identitygroups
      summary: Get identity group by name
      description: <p>This API allows the client to get an identity group by name.</p>
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- identity.identitygroup.1.1
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: Required Only if Enabled from GUI Example:- fetch
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identitygroup_name'
            application/xml:
              schema:
                $ref: '#/components/schemas/identitygroup_name'
  /ers/config/identitygroup/{id}:
    get:
      tags:
      - identitygroups
      summary: Get identity group by ID
      description: <p>This API allows the client to get an identity group by ID.</p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- identity.identitygroup.1.1
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: Required Only if Enabled from GUI Example:- fetch
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identitygroup'
            application/xml:
              schema:
                $ref: '#/components/schemas/identitygroup'
    delete:
      tags:
      - identitygroups
      summary: Delete identity group
      description: <p>This API allows the client to delete an identity group.</p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- identity.identitygroup.1.1
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: Required Only if Enabled from GUI Example:- fetch
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identitygroup'
            application/xml:
              schema:
                $ref: '#/components/schemas/identitygroup'
    patch:
      tags:
      - identitygroups
      summary: Update part of the identity group by ID
      description: <p>This API allows the user to update part of the identity group by ID.</p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- identity.identitygroup.1.1
        required: false
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identitygroup'
            application/xml:
              schema:
                $ref: '#/components/schemas/identitygroup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/patchRequest'
    put:
      tags:
      - identitygroups
      summary: Update identity group
      description: <p>This API allows the client to update an identity group.</p>
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- identity.identitygroup.1.1
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: The Token value from the GET X-CSRF-TOKEN fetch request
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Update'
            application/xml:
              schema:
                $ref: '#/components/schemas/Update'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identitygroup'
          application/xml:
            schema:
              $ref: '#/components/schemas/identitygroup'
  /ers/config/identitygroup:
    get:
      tags:
      - identitygroups
      summary: Get all identity groups
      description: <p>This API allows the client to get all the identity groups.</p> <p><h1>Filter:</h1> <h3>[name, description]</h3></p> <p>To search guest users by using <b>toDate</b> column,follow the format:</p> <p>DD-MON-YY (Example:13-SEP-18)</p> <ul> <li><p>Day or Year:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13</p></li> <li><p>Month:GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP</p></li> <li><p>Date:GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18</p></li> </ul> <p><h1>Sorting:</h1> <h3>[name, description]</h3></p>
      parameters:
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- identity.identitygroup.1.1
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: Required Only if Enabled from GUI Example:- fetch
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/search'
            application/xml:
              schema:
                $ref: '#/components/schemas/search'
    post:
      tags:
      - identitygroups
      summary: Create identity group
      description: <p>This API creates an identity group.</p>
      parameters:
      - in: header
        name: HTTP ERS-Media-Type Header
        description: Example:- identity.identitygroup.1.1
        required: false
        schema:
          type: string
      - in: header
        name: HTTP X-CSRF-TOKEN Header
        description: The Token value from the GET X-CSRF-TOKEN fetch request
        schema:
          type: string
      responses:
        201:
          description: Created
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identitygroup'
          application/xml:
            schema:
              $ref: '#/components/schemas/identitygroup'
  /ers/config/identitygroup/versioninfo:
    get:
      tags:
      - identitygroups
      summary: Get identity group version information
      description: <p>This API helps to retrieve the version information related to identity group.</p>
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionInfo'
components:
  schemas:
    IdentityGroup_name:
      type: object
      properties:
        id:
          type: string
          example: 9efe2310-8c01-11e6-996c-525400b48521
        name:
          type: string
          example: GuestType_Weekly (default)
        description:
          type: string
          example: Identity group mirroring the guest type
        parent:
          type: string
          example: NAC Group:NAC:IdentityGroups:User Identity Groups
        link:
          type: object
          properties:
            rel:
              type: string
              example: self
            href:
              type: string
              example: https://<ise-ip>:9060/ers/config/identitygroup/name/GuestType_Weekly (default)
            type:
              type: string
              example: application/json
    patchRequestBody:
      type: object
      properties:
        any-resource-attribute:
          type: string
          example: some-updated-value
        another-resource-attribute:
          type: string
          example: some-updated-value
    Update:
      type: object
      properties:
        UpdatedFieldsList:
          $ref: '#/components/schemas/UpdatedFieldsList'
    VersionInfo:
      type: object
      properties:
        VersionInfo:
          $ref: '#/components/schemas/version'
    SearchResult:
      type: object
      properties:
        total:
          type: integer
          example: 8
        resources:
          type: array
          example:
          - id: 9efe2310-8c01-11e6-996c-525400b48521
            name: GuestType_Weekly (default)
            description: Identity group mirroring the guest type
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/identitygroup/9efe2310-8c01-11e6-996c-525400b48521
              type: application/json
          - id: a19d5f00-8c01-11e6-996c-525400b48521
            name: OWN_ACCOUNTS (default)
            description: Default OWN_ACCOUNTS (default) User Group
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/identitygroup/a19d5f00-8c01-11e6-996c-525400b48521
              type: application/json
          - id: a1bb2030-8c01-11e6-996c-525400b48521
            name: GROUP_ACCOUNTS (default)
            description: Default GROUP_ACCOUNTS (default) User Group
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/identitygroup/a1bb2030-8c01-11e6-996c-525400b48521
              type: application/json
          - id: a1740510-8c01-11e6-996c-525400b48521
            name: Employee
            description: Default Employee User Group
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/identitygroup/a1740510-8c01-11e6-996c-525400b48521
              type: application/json
          - id: 9eee92b0-8c01-11e6-996c-525400b48521
            name: GuestType_Daily (default)
            description: Identity group mirroring the guest type
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/identitygroup/9eee92b0-8c01-11e6-996c-525400b48521
              type: application/json
          - id: ba775150-7a56-11eb-bf1f-0050568fa723
            name: GuestType_SocialLogin (default)
            description: Identity group mirroring the guest type
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/identitygroup/ba775150-7a56-11eb-bf1f-0050568fa723
              type: application/json
          - id: 9f048bb0-8c01-11e6-996c-525400b48521
            name: GuestType_Contractor (default)
            description: Identity group mirroring the guest type
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/identitygroup/9f048bb0-8c01-11e6-996c-525400b48521
              type: application/json
          - id: a176c430-8c01-11e6-996c-525400b48521
            name: ALL_ACCOUNTS (default)
            description: Default ALL_ACCOUNTS (default) User Group
            link:
              rel: self
              href: https://<ise-ip>:9060/ers/config/ers/config/identitygroup/a176c430-8c01-11e6-996c-525400b48521
              type: application/json
          items:
            properties:
              name:
                type: string
    patchRequest:
      type: object
      properties:
        IdentityGroup:
          $ref: '#/components/schemas/patchRequestBody'
    IdentityGroup:
      type: object
      properties:
        id:
          type: string
          example: 9efe2310-8c01-11e6-996c-525400b48521
        name:
          type: string
          example: GuestType_Weekly (default)
        description:
          type: string
          example: Identity group mirroring the guest type
        parent:
          type: string
          example: NAC Group:NAC:IdentityGroups:User Identity Groups
        link:
          type: object
          properties:
            rel:
              type: string
              example: self
            href:
              type: string
              example: https://<ise-ip>:9060/ers/config/identitygroup/9efe2310-8c01-11e6-996c-525400b48521
            type:
              type: string
              example: application/json
    identitygroup:
      type: object
      properties:
        IdentityGroup:
          $ref: '#/components/schemas/IdentityGroup'
    search:
      type: object
      properties:
        SearchResult:
          $ref: '#/components/schemas/SearchResult'
    UpdatedFieldsList:
      type: object
      properties:
        updatedField:
          $ref: '#/components/schemas/UpdatedField'
        field:
          type: string
          example: some other field
        oldValue:
          type: string
          example: val_old
        newValue:
          type: string
          example: val_new
    version:
      type: object
      properties:
        currentServerVersion:
          type: string
          example: '1.1'
        supportedVersions:
          type: string
          example: 1.0,1.1
        link:
          $ref: '#/components/schemas/link1'
    UpdatedField:
      type: object
      properties:
        field:
          type: string
          example: field1
        oldValue:
          type: string
          example: val_old
        newValue:
          type: string
          example: val_new
    identitygroup_name:
      type: object
      properties:
        IdentityGroup:
          $ref: '#/components/schemas/IdentityGroup_name'
    link1:
      type: object
      properties:
        rel:
          type: string
          example: self
        href:
          type: string
          example: <ise-ip>/ers/config/identitygroup/versioninfo
        type:
          type: string
          example: application/json
Cisco Identity Services Engine Identitygroups API

Documentation

Specifications

Other Resources

OpenAPI Specification
