Cisco Identity Services Engine
Cisco Identity Services Engine Sponsorgroup API

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

openapi: 3.2.0
info:
  title: ISE ERS Sponsorgroup API
  version: 3.1.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}:{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'
security:
- HTTPBasicAuthentication: []
tags:
- name: sponsorgroup
paths:
  /sponsorgroup/:
    get:
      tags:
      - sponsorgroup
      summary: Get-All
      parameters:
      - name: filter
        in: query
        description: Filter Supported Fields:[name]
        required: false
        allowReserved: true
        schema:
          type: string
          example: toDate.CONTAINS.SEP
      - $ref: '#/components/parameters/ppage'
      - $ref: '#/components/parameters/psize'
      - name: sortdsc
        in: query
        description: Sorting Supported Fields:[name, description]
        required: false
        allowReserved: true
        schema:
          example: null
          enum:
          - name
          - description
      - name: sortasc
        in: query
        description: Sorting Supported Fields:[name, description]
        required: false
        allowReserved: true
        schema:
          example: null
          enum:
          - name
          - description
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sponsorgroupListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/sponsorgroupListResponse'
            text/html:
              schema:
                type: string
                example: null
        '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
    post:
      tags:
      - sponsorgroup
      summary: Create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.sponsorgroup'
            example:
              SponsorGroup:
                guestTypes:
                - Contractor (default)
                - Daily (default)
                - Weekly (default)
                isDefaultGroup: false
                isEnabled: true
                name: name
                managePermission: ALLACCOUNTS
                description: description
                createPermissions:
                  canImportMultipleAccounts: true
                  canCreateRandomAccounts: true
                  canSpecifyUsernamePrefix: false
                  startDateFutureLimitDays: 10
                  importBatchSizeLimit: 20
                  defaultUsernamePrefix: ''
                  canSetFutureStartDate: false
                  randomBatchSizeLimit: 30
                locations:
                - San Jose
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
                memberGroups:
                - ALL_ACCOUNTS (default)
                autoNotification: false
                otherPermissions:
                  canDeleteGuestAccounts: false
                  canResetGuestPasswords: false
                  canViewGuestPasswords: false
                  canUpdateGuestContactInfo: false
                  canSuspendGuestAccounts: false
                  canExtendGuestAccounts: false
                  canSendSmsNotifications: false
                  requireSuspensionReason: false
                  canReinstateSuspendedAccounts: false
                  canApproveSelfregGuests: false
                  canAccessViaRest: false
                  limitApprovalToSponsorsGuests: false
        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
  /sponsorgroup/{id}:
    get:
      tags:
      - sponsorgroup
      summary: Get-By-Id
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sponsorgroupResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/sponsorgroupResponse'
            text/html:
              schema:
                type: string
                example: null
        '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
    put:
      tags:
      - sponsorgroup
      summary: UpdateById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.sponsorgroup'
            example:
              SponsorGroup:
                guestTypes:
                - Contractor (default)
                - Daily (default)
                - Weekly (default)
                isDefaultGroup: false
                isEnabled: true
                name: name
                managePermission: ALLACCOUNTS
                description: description
                createPermissions:
                  canImportMultipleAccounts: true
                  canCreateRandomAccounts: true
                  canSpecifyUsernamePrefix: false
                  startDateFutureLimitDays: 10
                  importBatchSizeLimit: 20
                  defaultUsernamePrefix: ''
                  canSetFutureStartDate: false
                  randomBatchSizeLimit: 30
                locations:
                - San Jose
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
                memberGroups:
                - ALL_ACCOUNTS (default)
                autoNotification: false
                otherPermissions:
                  canDeleteGuestAccounts: false
                  canResetGuestPasswords: false
                  canViewGuestPasswords: false
                  canUpdateGuestContactInfo: false
                  canSuspendGuestAccounts: false
                  canExtendGuestAccounts: false
                  canSendSmsNotifications: false
                  requireSuspensionReason: false
                  canReinstateSuspendedAccounts: false
                  canApproveSelfregGuests: false
                  canAccessViaRest: false
                  limitApprovalToSponsorsGuests: false
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatedFieldsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/UpdatedFieldsResponse'
        '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 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
    delete:
      tags:
      - sponsorgroup
      summary: DeleteById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '204':
          description: No Content
        '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
components:
  schemas:
    Link:
      type: object
      properties:
        rel:
          type: string
          example: self
          enum:
          - next
          - previous
          - self
          - status
        href:
          type: string
          example: https://{server}:{port}/ers/config
        type:
          type: string
          example: application/json
      example: null
    sponsorgroupListResponseEntity:
      properties:
        id:
          title: id
          type: string
          description: Id description
          example: null
        name:
          title: name
          type: string
          description: name description
          example: null
        description:
          title: description
          type: string
          description: description
          example: null
        link:
          $ref: '#/components/schemas/Link'
      example: null
    sponsorgroupResponse:
      type: object
      properties:
        SponsorGroup:
          $ref: '#/components/schemas/sponsorgroupResponseEntity'
      example:
        SponsorGroup:
          guestTypes:
          - Contractor (default)
          - Daily (default)
          - Weekly (default)
          isDefaultGroup: false
          isEnabled: true
          name: name
          managePermission: ALLACCOUNTS
          description: description
          createPermissions:
            canImportMultipleAccounts: true
            canCreateRandomAccounts: true
            canSpecifyUsernamePrefix: false
            startDateFutureLimitDays: 10
            importBatchSizeLimit: 20
            defaultUsernamePrefix: ''
            canSetFutureStartDate: false
            randomBatchSizeLimit: 30
          locations:
          - San Jose
          id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
          memberGroups:
          - ALL_ACCOUNTS (default)
          autoNotification: false
          otherPermissions:
            canDeleteGuestAccounts: false
            canResetGuestPasswords: false
            canViewGuestPasswords: false
            canUpdateGuestContactInfo: false
            canSuspendGuestAccounts: false
            canExtendGuestAccounts: false
            canSendSmsNotifications: false
            requireSuspensionReason: false
            canReinstateSuspendedAccounts: false
            canApproveSelfregGuests: false
            canAccessViaRest: false
            limitApprovalToSponsorsGuests: false
    updatedField:
      properties:
        field:
          type: string
          example: null
        oldValue:
          type: string
          example: null
        newValue:
          type: string
          example: null
      example: null
    identity.sponsorgroup:
      required:
      - SponsorGroup
      type: object
      properties:
        SponsorGroup:
          $ref: '#/components/schemas/SponsorGroup'
      example: null
    sponsorgroupResponseEntity:
      properties:
        isEnabled:
          title: isEnabled
          type: boolean
          description: ''
          example: null
        isDefaultGroup:
          title: isDefaultGroup
          type: boolean
          description: ''
          example: null
        memberGroups:
          title: memberGroups
          type: array
          description: ''
          example: null
          items:
            type: string
            example: null
        guestTypes:
          title: guestTypes
          type: array
          description: ''
          example: null
          items:
            type: string
            example: null
        locations:
          title: locations
          type: array
          description: ''
          example: null
          items:
            type: string
            example: null
        autoNotification:
          title: autoNotification
          type: boolean
          description: ''
          example: null
        managePermission:
          title: managePermission
          type: object
          description: Allowed values:allAccounts, groupAccounts, ownAccounts
          example: null
        createPermissions:
          properties:
            canImportMultipleAccounts:
              title: canImportMultipleAccounts
              type: boolean
              description: ''
              example: null
            importBatchSizeLimit:
              title: importBatchSizeLimit
              type: number
              description: ''
              example: null
            canCreateRandomAccounts:
              title: canCreateRandomAccounts
              type: boolean
              description: ''
              example: null
            randomBatchSizeLimit:
              title: randomBatchSizeLimit
              type: number
              description: ''
              example: null
            defaultUsernamePrefix:
              title: defaultUsernamePrefix
              type: string
              description: ''
              example: null
            canSpecifyUsernamePrefix:
              title: canSpecifyUsernamePrefix
              type: boolean
              description: ''
              example: null
            canSetFutureStartDate:
              title: canSetFutureStartDate
              type: boolean
              description: ''
              example: null
            startDateFutureLimitDays:
              title: startDateFutureLimitDays
              type: number
              description: ''
              example: null
          example: null
        otherPermissions:
          properties:
            canUpdateGuestContactInfo:
              title: canUpdateGuestContactInfo
              type: boolean
              description: ''
              example: null
            canViewGuestPasswords:
              title: canViewGuestPasswords
              type: boolean
              description: ''
              example: null
            canSendSmsNotifications:
              title: canSendSmsNotifications
              type: boolean
              description: ''
              example: null
            canResetGuestPasswords:
              title: canResetGuestPasswords
              type: boolean
              description: ''
              example: null
            canExtendGuestAccounts:
              title: canExtendGuestAccounts
              type: boolean
              description: ''
              example: null
            canDeleteGuestAccounts:
              title: canDeleteGuestAccounts
              type: boolean
              description: ''
              example: null
            canSuspendGuestAccounts:
              title: canSuspendGuestAccounts
              type: boolean
              description: ''
              example: null
            requireSuspensionReason:
              title: requireSuspensionReason
              type: boolean
              description: ''
              example: null
            canReinstateSuspendedAccounts:
              title: canReinstateSuspendedAccounts
              type: boolean
              description: ''
              example: null
            canApproveSelfregGuests:
              title: canApproveSelfregGuests
              type: boolean
              description: ''
              example: null
            limitApprovalToSponsorsGuests:
              title: limitApprovalToSponsorsGuests
              type: boolean
              description: ''
              example: null
            canAccessViaRest:
              title: canAccessViaRest
              type: boolean
              description: ''
              example: null
          example: null
        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
        link:
          $ref: '#/components/schemas/Link'
      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
    SponsorGroup:
      required:
      - name
      properties:
        isEnabled:
          title: isEnabled
          type: boolean
          description: ''
          example: null
        isDefaultGroup:
          title: isDefaultGroup
          type: boolean
          description: ''
          example: null
        memberGroups:
          title: memberGroups
          type: array
          description: ''
          example: null
          items:
            type: string
            example: null
        guestTypes:
          title: guestTypes
          type: array
          description: ''
          example: null
          items:
            type: string
            example: null
        locations:
          title: locations
          type: array
          description: ''
          example: null
          items:
            type: string
            example: null
        autoNotification:
          title: autoNotification
          type: boolean
          description: ''
          example: null
        managePermission:
          title: managePermission
          type: object
          description: Allowed values:allAccounts, groupAccounts, ownAccounts
          example: null
        createPermissions:
          properties:
            canImportMultipleAccounts:
              title: canImportMultipleAccounts
              type: boolean
              description: ''
              example: null
            importBatchSizeLimit:
              title: importBatchSizeLimit
              type: number
              description: ''
              example: null
            canCreateRandomAccounts:
              title: canCreateRandomAccounts
              type: boolean
              description: ''
              example: null
            randomBatchSizeLimit:
              title: randomBatchSizeLimit
              type: number
              description: ''
              example: null
            defaultUsernamePrefix:
              title: defaultUsernamePrefix
              type: string
              description: ''
              example: null
            canSpecifyUsernamePrefix:
              title: canSpecifyUsernamePrefix
              type: boolean
              description: ''
              example: null
            canSetFutureStartDate:
              title: canSetFutureStartDate
              type: boolean
              description: ''
              example: null
            startDateFutureLimitDays:
              title: startDateFutureLimitDays
              type: number
              description: ''
              example: null
          example: null
        otherPermissions:
          required:
          - canSuspendGuestAccounts
          - limitApprovalToSponsorsGuests
          properties:
            canUpdateGuestContactInfo:
              title: canUpdateGuestContactInfo
              type: boolean
              description: ''
              example: null
            canViewGuestPasswords:
              title: canViewGuestPasswords
              type: boolean
              description: ''
              example: null
            canSendSmsNotifications:
              title: canSendSmsNotifications
              type: boolean
              description: ''
              example: null
            canResetGuestPasswords:
              title: canResetGuestPasswords
              type: boolean
              description: ''
              example: null
            canExtendGuestAccounts:
              title: canExtendGuestAccounts
              type: boolean
              description: ''
              example: null
            canDeleteGuestAccounts:
              title: canDeleteGuestAccounts
              type: boolean
              description: ''
              example: null
            canSuspendGuestAccounts:
              title: canSuspendGuestAccounts
              type: boolean
              description: ''
              example: null
            requireSuspensionReason:
              title: requireSuspensionReason
              type: boolean
              description: ''
              example: null
            canReinstateSuspendedAccounts:
              title: canReinstateSuspendedAccounts
              type: boolean
              description: ''
              example: null
            canApproveSelfregGuests:
              title: canApproveSelfregGuests
              type: boolean
              description: ''
              example: null
            limitApprovalToSponsorsGuests:
              title: limitApprovalToSponsorsGuests
              type: boolean
              description: ''
              example: null
            canAccessViaRest:
              title: canAccessViaRest
              type: boolean
              description: ''
              example: null
          example: null
        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:
        SponsorGroup:
          guestTypes:
          - Contractor (default)
          - Daily (default)
          - Weekly (default)
          isDefaultGroup: false
          isEnabled: true
          name: name
          managePermission: ALLACCOUNTS
          description: description
          createPermissions:
            canImportMultipleAccounts: true
            canCreateRandomAccounts: true
            canSpecifyUsernamePrefix: false
            startDateFutureLimitDays: 10
            importBatchSizeLimit: 20
            defaultUsernamePrefix: ''
            canSetFutureStartDate: false
            randomBatchSizeLimit: 30
          locations:
          - San Jose
          id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
          memberGroups:
          - ALL_ACCOUNTS (default)
          autoNotification: false
          otherPermissions:
            canDeleteGuestAccounts: false
            canResetGuestPasswords: false
            canViewGuestPasswords: false
            canUpdateGuestContactInfo: false
            canSuspendGuestAccounts: false
            canExtendGuestAccounts: false
            canSendSmsNotifications: false
            requireSuspensionReason: false
            canReinstateSuspendedAccounts: false
            canApproveSelfregGuests: false
            canAccessViaRest: false
            limitApprovalToSponsorsGuests: false
    sponsorgroupListResponse:
      type: object
      properties:
        SearchResult:
          type: object
          properties:
            total:
              type: integer
              example: '2'
            resources:
              type: array
              example: null
              items:
                $ref: '#/components/schemas/sponsorgroupListResponseEntity'
          example: null
      example:
        SearchResult:
          total: 2
          previousPage:
            rel: previous
            href: link-to-previous-page
            type: application/xml
          nextPage:
            rel: next
            href: link-to-next-page
            type: application/xml
          resources:
          - name: name1
            link:
              rel: self
              href: <url to resource name1>
              type: application/xml
            description: description1
            id: id1
          - name: name2
            link:
              rel: self
              href: <url to resource name2>
              type: application/xml
            description: description2
            id: id2
    UpdatedFieldsResponse:
      type: object
      properties:
        UpdatedFieldsList:
          type: object
          properties:
            updatedField:
              type: array
              example: null
              items:
                $ref: '#/components/schemas/updatedField'
          example: null
      example: null
  parameters:
    ppage:
      name: page
      in: query
      description: Page Number (0...N)
      allowReserved: true
      schema:
        type: integer
        example: null
      example: '1'
    psize:
      name: size
      in: query
      description: Items by Page
      allowReserved: true
      schema:
        type: integer
        example: null
      example: '20'
  securitySchemes:
    HTTPBasicAuthentication:
      type: http
      scheme: basic
Cisco Identity Services Engine Sponsorgroup API

Documentation

Specifications

Other Resources

OpenAPI Specification
