Cisco Identity Services Engine Selfregportal API

openapi: 3.2.0
info:
  title: ISE ERS Selfregportal 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: selfregportal
paths:
  /selfregportal/:
    get:
      tags:
      - selfregportal
      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/selfregportalListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/selfregportalListResponse'
            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:
      - selfregportal
      summary: Create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/portal.selfregportal'
            example:
              SelfRegPortal:
                portalType: SELFREGGUEST
                settings:
                  loginPageSettings:
                    maxFailedAttemptsBeforeRateLimit: 5
                    allowGuestToChangePassword: false
                    requireAccessCode: false
                    allowGuestToCreateAccounts: false
                    includeAup: false
                    allowAlternateGuestPortal: false
                    socialConfigs: []
                    timeBetweenLoginsDuringRateLimit: 2
                    allowShowGuestForm: false
                    allowForgotPassword: false
                    accessCode: Access Code
                    allowGuestToUseSocialAccounts: false
                    requireAupAcceptance: false
                    requireAupScrolling: false
                    aupDisplay: ASLINK
                  authSuccessSettings:
                    redirectUrl: www.cisco.com
                    successRedirect: AUTHSUCCESSPAGE
                  supportInfoSettings:
                    includePolicyServer: true
                    includeFailureCode: true
                    includeMacAddr: true
                    includeBrowserUserAgent: true
                    includeSupportInfoPage: false
                    includeIpAddress: true
                    emptyFieldDisplay: HIDE
                  selfRegSuccessSettings:
                    includeCompany: true
                    includePassword: true
                    allowGuestSendSelfUsingPrint: true
                    includeAup: false
                    includePhoneNo: true
                    includeReasonForVisit: true
                    includeUserName: true
                    allowGuestSendSelfUsingEmail: true
                    includeLastName: true
                    includeSmsProvider: true
                    includeLocation: true
                    allowGuestLoginFromSelfregSuccessPage: true
                    includeEmailAddr: true
                    allowGuestSendSelfUsingSms: true
                    includeFirstName: true
                    requireAupAcceptance: false
                    requireAupScrolling: false
                    includePersonBeingVisited: true
                    aupOnPage: false
                  guestChangePasswordSettings:
                    allowChangePasswdAtFirstLogin: false
                  aupSettings:
                    requireAccessCode: false
                    requireScrolling: true
                    includeAup: false
                    useDiffAupForEmployees: false
                    displayFrequency: FIRSTLOGIN
                    skipAupForEmployees: true
                  postLoginBannerSettings:
                    includePostAccessBanner: true
                  portalSettings:
                    allowedInterfaces:
                    - eth0
                    - bond0
                    endpointIdentityGroup: f14227b0-6e5c-11e6-8f6a-005056873bd0
                    authenticationMethod: Identity Sequence
                    availableSsids: []
                    certificateGroupTag: Default Portal Certificate Group
                    assignedGuestTypeForEmployee: Guest Type configured
                    alwaysUsedLanguage: English
                    displayLang: USEBROWSERLOCALE
                    fallbackLanguage: English
                    httpsPort: 8443
                  guestDeviceRegistrationSettings:
                    autoRegisterGuestDevices: false
                    allowGuestsToRegisterDevices: true
                  selfRegPageSettings:
                    enableGuestEmailWhitelist: false
                    autoLoginSelfWait: false
                    fieldLastName:
                      include: true
                      require: false
                    accountValidityTimeUnits: DAYS
                    requireGuestApproval: false
                    autoLoginTimePeriod: 1
                    postRegistrationRedirect: SELFREGISTRATIONSUCCESS
                    accountValidityDuration: 1
                    approveDenyLinksTimeUnits: DAYS
                    assignGuestsToGuestType: Guest Type
                    credentialNotificationUsingSms: false
                    registrationCode: Registration Code
                    guestEmailWhitelistDomains:
                    - test@cisco.com
                    requireAupAcceptance: false
                    enableGuestEmailBlacklist: false
                    authenticateSponsorsUsingPortalList: false
                    aupDisplay: ASLINK
                    requireRegistrationCode: false
                    fieldCompany:
                      include: true
                      require: false
                    fieldSmsProvider:
                      include: true
                      require: false
                    fieldReasonForVisit:
                      include: true
                      require: false
                    fieldLocation:
                      include: true
                      require: false
                    allowGraceAccess: false
                    graceAccessExpireInterval: 10
                    sendApprovalRequestTo: SELECTEDEMAILADDRESSES
                    guestEmailBlacklistDomains:
                    - test1@cisco.com
                    selectableSmsProviders:
                    - Sms1
                    includeAup: false
                    fieldUserName:
                      include: true
                      require: false
                    fieldPhoneNo:
                      include: true
                      require: false
                    graceAccessSendAccountExpiration: false
                    credentialNotificationUsingEmail: false
                    selectableLocations:
                    - location1
                    - location2
                    fieldEmailAddr:
                      include: true
                      require: false
                    sponsorPortalList: []
                    fieldFirstName:
                      include: true
                      require: false
                name: name
                description: description
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
                customizations:
                  globalCustomizations:
                    bannerImage:
                      data: base 64 encoded value of image
                    contactText: 'Contact Information '
                    bannerTitle: Banner Title
                    desktopLogoImage:
                      data: base 64 encoded value of image
                    mobileLogoImage:
                      data: base 64 encoded value of image
                    footerElement: Footer Element
                  portalTweakSettings:
                    pageBackgroundColor: Color code from GUI
                    pageLabelAndTextColor: Label and Text color from GUI
                    bannerColor: Banner Color from GUI
                    bannerTextColor: Banner Text color code from GUI
                  pageCustomizations:
                    data:
                    - value: Contact Support
                      key: ui_contact_link
                  language:
                    viewLanguage: English
                  portalTheme:
                    themeData: Base 64 encoded string of Theme CSS file
                    name: ThemeName
                    id: themeId
        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
  /selfregportal/{portal-id}:
    get:
      tags:
      - selfregportal
      summary: Get-By-Id
      parameters:
      - name: portal-id
        in: path
        required: true
        schema:
          title: portal-id
          type: string
          example: null
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/selfregportalResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/selfregportalResponse'
            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:
      - selfregportal
      summary: UpdateById
      parameters:
      - name: portal-id
        in: path
        required: true
        schema:
          title: portal-id
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/portal.selfregportal'
            example:
              SelfRegPortal:
                portalType: SELFREGGUEST
                settings:
                  loginPageSettings:
                    maxFailedAttemptsBeforeRateLimit: 5
                    allowGuestToChangePassword: false
                    requireAccessCode: false
                    allowGuestToCreateAccounts: false
                    includeAup: false
                    allowAlternateGuestPortal: false
                    socialConfigs: []
                    timeBetweenLoginsDuringRateLimit: 2
                    allowShowGuestForm: false
                    allowForgotPassword: false
                    accessCode: Access Code
                    allowGuestToUseSocialAccounts: false
                    requireAupAcceptance: false
                    requireAupScrolling: false
                    aupDisplay: ASLINK
                  authSuccessSettings:
                    redirectUrl: www.cisco.com
                    successRedirect: AUTHSUCCESSPAGE
                  supportInfoSettings:
                    includePolicyServer: true
                    includeFailureCode: true
                    includeMacAddr: true
                    includeBrowserUserAgent: true
                    includeSupportInfoPage: false
                    includeIpAddress: true
                    emptyFieldDisplay: HIDE
                  selfRegSuccessSettings:
                    includeCompany: true
                    includePassword: true
                    allowGuestSendSelfUsingPrint: true
                    includeAup: false
                    includePhoneNo: true
                    includeReasonForVisit: true
                    includeUserName: true
                    allowGuestSendSelfUsingEmail: true
                    includeLastName: true
                    includeSmsProvider: true
                    includeLocation: true
                    allowGuestLoginFromSelfregSuccessPage: true
                    includeEmailAddr: true
                    allowGuestSendSelfUsingSms: true
                    includeFirstName: true
                    requireAupAcceptance: false
                    requireAupScrolling: false
                    includePersonBeingVisited: true
                    aupOnPage: false
                  guestChangePasswordSettings:
                    allowChangePasswdAtFirstLogin: false
                  aupSettings:
                    requireAccessCode: false
                    requireScrolling: true
                    includeAup: false
                    useDiffAupForEmployees: false
                    displayFrequency: FIRSTLOGIN
                    skipAupForEmployees: true
                  postLoginBannerSettings:
                    includePostAccessBanner: true
                  portalSettings:
                    allowedInterfaces:
                    - eth0
                    - bond0
                    endpointIdentityGroup: f14227b0-6e5c-11e6-8f6a-005056873bd0
                    authenticationMethod: Identity Sequence
                    availableSsids: []
                    certificateGroupTag: Default Portal Certificate Group
                    assignedGuestTypeForEmployee: Guest Type configured
                    alwaysUsedLanguage: English
                    displayLang: USEBROWSERLOCALE
                    fallbackLanguage: English
                    httpsPort: 8443
                  guestDeviceRegistrationSettings:
                    autoRegisterGuestDevices: false
                    allowGuestsToRegisterDevices: true
                  selfRegPageSettings:
                    enableGuestEmailWhitelist: false
                    autoLoginSelfWait: false
                    fieldLastName:
                      include: true
                      require: false
                    accountValidityTimeUnits: DAYS
                    requireGuestApproval: false
                    autoLoginTimePeriod: 1
                    postRegistrationRedirect: SELFREGISTRATIONSUCCESS
                    accountValidityDuration: 1
                    approveDenyLinksTimeUnits: DAYS
                    assignGuestsToGuestType: Guest Type
                    credentialNotificationUsingSms: false
                    registrationCode: Registration Code
                    guestEmailWhitelistDomains:
                    - test@cisco.com
                    requireAupAcceptance: false
                    enableGuestEmailBlacklist: false
                    authenticateSponsorsUsingPortalList: false
                    aupDisplay: ASLINK
                    requireRegistrationCode: false
                    fieldCompany:
                      include: true
                      require: false
                    fieldSmsProvider:
                      include: true
                      require: false
                    fieldReasonForVisit:
                      include: true
                      require: false
                    fieldLocation:
                      include: true
                      require: false
                    allowGraceAccess: false
                    graceAccessExpireInterval: 10
                    sendApprovalRequestTo: SELECTEDEMAILADDRESSES
                    guestEmailBlacklistDomains:
                    - test1@cisco.com
                    selectableSmsProviders:
                    - Sms1
                    includeAup: false
                    fieldUserName:
                      include: true
                      require: false
                    fieldPhoneNo:
                      include: true
                      require: false
                    graceAccessSendAccountExpiration: false
                    credentialNotificationUsingEmail: false
                    selectableLocations:
                    - location1
                    - location2
                    fieldEmailAddr:
                      include: true
                      require: false
                    sponsorPortalList: []
                    fieldFirstName:
                      include: true
                      require: false
                name: name
                description: description
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
                customizations:
                  globalCustomizations:
                    bannerImage:
                      data: base 64 encoded value of image
                    contactText: 'Contact Information '
                    bannerTitle: Banner Title
                    desktopLogoImage:
                      data: base 64 encoded value of image
                    mobileLogoImage:
                      data: base 64 encoded value of image
                    footerElement: Footer Element
                  portalTweakSettings:
                    pageBackgroundColor: Color code from GUI
                    pageLabelAndTextColor: Label and Text color from GUI
                    bannerColor: Banner Color from GUI
                    bannerTextColor: Banner Text color code from GUI
                  pageCustomizations:
                    data:
                    - value: Contact Support
                      key: ui_contact_link
                  language:
                    viewLanguage: English
                  portalTheme:
                    themeData: Base 64 encoded string of Theme CSS file
                    name: ThemeName
                    id: themeId
        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:
      - selfregportal
      summary: DeleteById
      parameters:
      - name: portal-id
        in: path
        required: true
        schema:
          title: portal-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
    patch:
      tags:
      - selfregportal
      summary: Patch
      description: This API endpoint has the PATCH method enabled. However, only set of commonly used attributes has been been validated to work correctly with PATCH. The remaining attributes will be fixed over time. Partially validated functionality for common use cases has been provided as a convenience to API developers.
      parameters:
      - name: portal-id
        in: path
        required: true
        schema:
          title: portal-id
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/portal.selfregportal'
            example:
              SelfRegPortal:
                portalType: SELFREGGUEST
                settings:
                  loginPageSettings:
                    maxFailedAttemptsBeforeRateLimit: 5
                    allowGuestToChangePassword: false
                    requireAccessCode: false
                    allowGuestToCreateAccounts: false
                    includeAup: false
                    allowAlternateGuestPortal: false
                    socialConfigs: []
                    timeBetweenLoginsDuringRateLimit: 2
                    allowShowGuestForm: false
                    allowForgotPassword: false
                    accessCode: Access Code
                    allowGuestToUseSocialAccounts: false
                    requireAupAcceptance: false
                    requireAupScrolling: false
                    aupDisplay: ASLINK
                  authSuccessSettings:
                    redirectUrl: www.cisco.com
                    successRedirect: AUTHSUCCESSPAGE
                  supportInfoSettings:
                    includePolicyServer: true
                    includeFailureCode: true
                    includeMacAddr: true
                    includeBrowserUserAgent: true
                    includeSupportInfoPage: false
                    includeIpAddress: true
                    emptyFieldDisplay: HIDE
                  selfRegSuccessSettings:
                    includeCompany: true
                    includePassword: true
                    allowGuestSendSelfUsingPrint: true
                    includeAup: false
                    includePhoneNo: true
                    includeReasonForVisit: true
                    includeUserName: true
                    allowGuestSendSelfUsingEmail: true
                    includeLastName: true
                    includeSmsProvider: true
                    includeLocation: true
                    allowGuestLoginFromSelfregSuccessPage: true
                    includeEmailAddr: true
                    allowGuestSendSelfUsingSms: true
                    includeFirstName: true
                    requireAupAcceptance: false
                    requireAupScrolling: false
                    includePersonBeingVisited: true
                    aupOnPage: false
                  guestChangePasswordSettings:
                    allowChangePasswdAtFirstLogin: false
                  aupSettings:
                    requireAccessCode: false
                    requireScrolling: true
                    includeAup: false
                    useDiffAupForEmployees: false
                    displayFrequency: FIRSTLOGIN
                    skipAupForEmployees: true
                  postLoginBannerSettings:
                    includePostAccessBanner: true
                  portalSettings:
                    allowedInterfaces:
                    - eth0
                    - bond0
                    endpointIdentityGroup: f14227b0-6e5c-11e6-8f6a-005056873bd0
                    authenticationMethod: Identity Sequence
                    availableSsids: []
                    certificateGroupTag: Default Portal Certificate Group
                    assignedGuestTypeForEmployee: Guest Type configured
                    alwaysUsedLanguage: English
                    displayLang: USEBROWSERLOCALE
                    fallbackLanguage: English
                    httpsPort: 8443
                  guestDeviceRegistrationSettings:
                    autoRegisterGuestDevices: false
                    allowGuestsToRegisterDevices: true
                  selfRegPageSettings:
                    enableGuestEmailWhitelist: false
                    autoLoginSelfWait: false
                    fieldLastName:
                      include: true
                      require: false
                    accountValidityTimeUnits: DAYS
                    requireGuestApproval: false
                    autoLoginTimePeriod: 1
                    postRegistrationRedirect: SELFREGISTRATIONSUCCESS
                    accountValidityDuration: 1
                    approveDenyLinksTimeUnits: DAYS
                    assignGuestsToGuestType: Guest Type
                    credentialNotificationUsingSms: false
                    registrationCode: Registration Code
                    guestEmailWhitelistDomains:
                    - test@cisco.com
                    requireAupAcceptance: false
                    enableGuestEmailBlacklist: false
                    authenticateSponsorsUsingPortalList: false
                    aupDisplay: ASLINK
                    requireRegistrationCode: false
                    fieldCompany:
                      include: true
                      require: false
                    fieldSmsProvider:
                      include: true
                      require: false
                    fieldReasonForVisit:
                      include: true
                      require: false
                    fieldLocation:
                      include: true
                      require: false
                    allowGraceAccess: false
                    graceAccessExpireInterval: 10
                    sendApprovalRequestTo: SELECTEDEMAILADDRESSES
                    guestEmailBlacklistDomains:
                    - test1@cisco.com
                    selectableSmsProviders:
                    - Sms1
                    includeAup: false
                    fieldUserName:
                      include: true
                      require: false
                    fieldPhoneNo:
                      in

# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-ise/refs/heads/main/openapi/cisco-ise-selfregportal-api-openapi.yml