Cisco Identity Services Engine Restidstoregroup API

openapi: 3.2.0
info:
  title: Cisco Ise Restidstoregroup API
  version: '1.0'
  description: 'Operations tagged restidstoregroup across 2 of this provider''s published API definitions: cisco-ise-ers-open-api-ers-apis.yaml,
    cisco-ise-legacy-ers-rest-id-store.yaml. Each path carries the servers of the definition it was published in.'
  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.
    derived_view: Per-tag view of cisco-ise-ers-open-api-ers-apis.yaml, the provider's source document. Operations and schemas
      are the provider's, unmodified; only the partition is ours.
    derived_from: cisco-ise-ers-open-api-ers-apis.yaml
    operation_coverage: 1/2
  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}:{port}/ers/config
  description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs
  variables:
    server:
      description: The host where the API is rooted
      default: localhost
    port:
      description: The port no for CTS APIs is 9063 and for other APIs it is 443
      default: '443'
tags:
- name: restidstoregroup
paths:
  /restidstoregroup/fetchGroups:
    post:
      tags:
      - restidstoregroup
      summary: fetchGroups
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identitystores.restidstoregroup'
            example:
              ERSRestIDStoreAllGroups:
                filter: '*'
                clientID: <AZURE_CLIENT_ID>
                pageNumber: 1
                tenantID: <AZURE_TENANT_ID>
                pageSize: 20
                clientSecret: <AZURE_CLIENT_SECRET>
                restIDStoreName: ''
        required: true
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '406':
          description: Not Acceptable
        '415':
          description: UnSupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '500':
          description: Internal Server Error
      security:
      - HTTPBasicAuthentication: []
    servers:
    - url: https://{server}:{port}/ers/config
      description: Append /ctsapi/v2 or /ctsapi/v3 to above URL while accessing CTS APIs
      variables:
        server:
          description: The host where the API is rooted
          default: localhost
        port:
          description: The port no for CTS APIs is 9063 and for other APIs it is 443
          default: '443'
  /ers/config/restidstoregroup/fetchGroups:
    post:
      tags:
      - restidstoregroup
      summary: Fetch REST ID store groups
      description: '<p>This API fetches the groups from a REST ID store.</p> <p>Either (<b>clientID</b>, <b>clientSecret</b>,
        and <b>tenantID</b>) or <b>restIDStoreName</b> is mandatory.</p>

        '
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSRestIDStoreGroupsResponse'
        400:
          description: Bad Request - clientID/clientSecret/tenantID or restIDStoreName is required
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ERSRestIDStoreAllGroupsRequest'
        required: true
components:
  schemas:
    ERSRestIDStoreAllGroups:
      required:
      - name
      properties:
        name:
          title: name
          type: string
          description: name
          example: null
        id:
          title: id
          type: string
          description: Id
          example: null
        description:
          title: description
          type: string
          description: Description
          example: null
      example:
        ERSRestIDStoreAllGroups:
          filter: '*'
          clientID: <AZURE_CLIENT_ID>
          pageNumber: 1
          tenantID: <AZURE_TENANT_ID>
          pageSize: 20
          clientSecret: <AZURE_CLIENT_SECRET>
          restIDStoreName: ''
    identitystores.restidstoregroup:
      required:
      - ERSRestIDStoreAllGroups
      type: object
      properties:
        ERSRestIDStoreAllGroups:
          $ref: '#/components/schemas/ERSRestIDStoreAllGroups'
      example: null
    ERSResponse:
      type: object
      properties:
        operation:
          type: string
          example: Operation
        messages:
          type: array
          example: null
          items:
            properties:
              title:
                type: string
                example: title
              type:
                type: string
                example: type
              code:
                type: string
                example: code
            example: null
      example: null
    ERSRestIDStoreGroups:
      type: object
      properties:
        groups:
          type: array
          description: List of group names returned from the REST ID store.
          example:
          - group1
          - group2
          - group3
          - group4
          - group5
          items:
            type: string
    ERSRestIDStoreAllGroups_2:
      type: object
      description: 'Either (clientID, clientSecret, tenantID) or restIDStoreName is mandatory.

        '
      properties:
        clientID:
          type: string
          example: ''
          description: Azure AD client ID. Required if restIDStoreName is not provided.
        clientSecret:
          type: string
          example: ''
          description: Azure AD client secret. Required if restIDStoreName is not provided.
        tenantID:
          type: string
          example: ''
          description: Azure AD tenant ID. Required if restIDStoreName is not provided.
        restIDStoreName:
          type: string
          example: demo
          description: Name of the REST ID store. Required if clientID/clientSecret/tenantID are not provided.
        filter:
          type: string
          example: Sukumar11930
          description: Optional filter string to narrow down the group search.
        pageNumber:
          type: integer
          example: 1
          description: Page number for paginated results.
        pageSize:
          type: integer
          example: 10
          description: Number of groups to return per page.
    ERSRestIDStoreGroupsResponse:
      type: object
      properties:
        ERSRestIDStoreGroups:
          $ref: '#/components/schemas/ERSRestIDStoreGroups'
    ERSRestIDStoreAllGroupsRequest:
      type: object
      properties:
        ERSRestIDStoreAllGroups:
          $ref: '#/components/schemas/ERSRestIDStoreAllGroups_2'
  securitySchemes:
    HTTPBasicAuthentication:
      type: http
      scheme: basic
x-refined-from:
- cisco-ise-ers-open-api-ers-apis.yaml
- cisco-ise-legacy-ers-rest-id-store.yaml