openapi: 3.2.0 info: title: ISE ERS Sponsorportal 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: sponsorportal paths: /sponsorportal/: get: tags: - sponsorportal summary: Get-All parameters: - name: filter in: query description: Filter Supported Fields:[name, description] 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/sponsorportalListResponse' application/xml: schema: $ref: '#/components/schemas/sponsorportalListResponse' 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: - sponsorportal summary: Create parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/portal.sponsorportal' example: SponsorPortal: portalType: SPONSOR settings: loginPageSettings: maxFailedAttemptsBeforeRateLimit: 5 allowGuestToChangePassword: false requireAccessCode: false allowGuestToCreateAccounts: true includeAup: false allowAlternateGuestPortal: false socialConfigs: [] timeBetweenLoginsDuringRateLimit: 2 allowShowGuestForm: false allowForgotPassword: true allowGuestToUseSocialAccounts: false requireAupAcceptance: false requireAupScrolling: false aupDisplay: ASLINK supportInfoSettings: includePolicyServer: true includeFailureCode: true includeMacAddr: true includeBrowserUserAgent: true includeSupportInfoPage: false includeIpAddress: true emptyFieldDisplay: HIDE aupSettings: requireAccessCode: false requireScrolling: true includeAup: false useDiffAupForEmployees: false displayFrequency: FIRSTLOGIN skipAupForEmployees: false postLoginBannerSettings: includePostAccessBanner: true portalSettings: allowedInterfaces: - eth0 - bond0 fqdn: Fully Qualified Domain Name authenticationMethod: Identity Source availableSsids: - ssid1 - ssid2 certificateGroupTag: Default Portal Certificate Group idleTimeout: 10 alwaysUsedLanguage: English displayLang: USEBROWSERLOCALE fallbackLanguage: English httpsPort: 8443 sponsorChangePasswordSettings: allowSponsorToChangePwd: 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 /sponsorportal/{portal-id}: get: tags: - sponsorportal 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/sponsorportalResponse' application/xml: schema: $ref: '#/components/schemas/sponsorportalResponse' 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: - sponsorportal 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.sponsorportal' example: SponsorPortal: portalType: SPONSOR settings: loginPageSettings: maxFailedAttemptsBeforeRateLimit: 5 allowGuestToChangePassword: false requireAccessCode: false allowGuestToCreateAccounts: true includeAup: false allowAlternateGuestPortal: false socialConfigs: [] timeBetweenLoginsDuringRateLimit: 2 allowShowGuestForm: false allowForgotPassword: true allowGuestToUseSocialAccounts: false requireAupAcceptance: false requireAupScrolling: false aupDisplay: ASLINK supportInfoSettings: includePolicyServer: true includeFailureCode: true includeMacAddr: true includeBrowserUserAgent: true includeSupportInfoPage: false includeIpAddress: true emptyFieldDisplay: HIDE aupSettings: requireAccessCode: false requireScrolling: true includeAup: false useDiffAupForEmployees: false displayFrequency: FIRSTLOGIN skipAupForEmployees: false postLoginBannerSettings: includePostAccessBanner: true portalSettings: allowedInterfaces: - eth0 - bond0 fqdn: Fully Qualified Domain Name authenticationMethod: Identity Source availableSsids: - ssid1 - ssid2 certificateGroupTag: Default Portal Certificate Group idleTimeout: 10 alwaysUsedLanguage: English displayLang: USEBROWSERLOCALE fallbackLanguage: English httpsPort: 8443 sponsorChangePasswordSettings: allowSponsorToChangePwd: 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: - sponsorportal 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 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 sponsorportalListResponse: type: object properties: SearchResult: type: object properties: total: type: integer example: '2' resources: type: array example: null items: $ref: '#/components/schemas/sponsorportalListResponseEntity' 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: type: application/xml description: description1 id: id1 - name: name2 link: rel: self href: type: application/xml description: description2 id: id2 portal.sponsorportal: required: - SponsorPortal type: object properties: SponsorPortal: $ref: '#/components/schemas/SponsorPortal' example: null updatedField: properties: field: type: string example: null oldValue: type: string example: null newValue: type: string example: null example: null sponsorportalResponse: type: object properties: SponsorPortal: $ref: '#/components/schemas/sponsorportalResponseEntity' example: SponsorPortal: portalType: SPONSOR settings: loginPageSettings: maxFailedAttemptsBeforeRateLimit: 5 allowGuestToChangePassword: false requireAccessCode: false allowGuestToCreateAccounts: true includeAup: false allowAlternateGuestPortal: false socialConfigs: [] timeBetweenLoginsDuringRateLimit: 2 allowShowGuestForm: false allowForgotPassword: true allowGuestToUseSocialAccounts: false requireAupAcceptance: false requireAupScrolling: false aupDisplay: ASLINK supportInfoSettings: includePolicyServer: true includeFailureCode: true includeMacAddr: true includeBrowserUserAgent: true includeSupportInfoPage: false includeIpAddress: true emptyFieldDisplay: HIDE aupSettings: requireAccessCode: false requireScrolling: true includeAup: false useDiffAupForEmployees: false displayFrequency: FIRSTLOGIN skipAupForEmployees: false postLoginBannerSettings: includePostAccessBanner: true portalSettings: allowedInterfaces: - eth0 - bond0 fqdn: Fully Qualified Domain Name authenticationMethod: Identity Source availableSsids: - ssid1 - ssid2 certificateGroupTag: Default Portal Certificate Group idleTimeout: 10 alwaysUsedLanguage: English displayLang: USEBROWSERLOCALE fallbackLanguage: English httpsPort: 8443 sponsorChangePasswordSettings: allowSponsorToChangePwd: 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 sponsorportalResponseEntity: properties: portalTestUrl: title: portalTestUrl type: string description: URL to bring up a test page for this portal example: null portalType: title: portalType type: string description: 'allowed values: byod, hotspotGuest, mydevice, selfRegGuest, sponsor and sponsoredGuest' example: null settings: properties: portalSettings: properties: httpsPort: title: httpsPort type: number description: The port number that the allowed interfaces will listen on. Range from 8000 to 8999 example: null allowedInterfaces: title: allowedInterfaces type: string description: 'Interfaces that the portal will be reachable on. allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1 and bond2' example: null certificateGroupTag: title: certificateGroupTag type: string description: Logical name of the x.509 server certificate that will be used for the portal. example: null fqdn: title: fqdn type: string description: The fully-qualified domain name (FQDN) that end-users will use to access this portal. Used only in Sponsor portal. example: null authenticationMethod: title: authenticationMethod type: string description: Unique Id of the identity source sequence . example: null idleTimeout: title: idleTimeout type: number description: '' example: null displayLang: title: displayLang type: string description: 'allowed values: useBrowserLocale and alwaysUse' example: null fallbackLanguage: title: fallbackLanguage type: string description: Used when displayLang = useBrowserLocale example: null alwaysUsedLanguage: title: alwaysUsedLanguage type: string description: Used when displayLang = alwaysUse example: null availableSsids: title: availableSsids type: string description: Names of the SSIDs available for assignment to guest users by sponsors. example: null example: null loginPageSettings: properties: maxFailedAttemptsBeforeRateLimit: title: maxFailedAttemptsBeforeRateLimit type: number description: Maximum failed login attempts before rate limiting. example: null timeBetweenLoginsDuringRateLimit: title: timeBetweenLoginsDuringRateLimit type: number description: Time between login attempts when rate limiting example: null includeAup: title: includeAup type: boolean description: Include an Acceptable Use Policy (AUP) that should be displayed during login. example: null aupDisplay: title: aupDisplay type: string description: How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values onPage and asLink example: null requireAupAcceptance: title: requireAupAcceptance type: boolean description: Require the portal user to accept the AUP. Only valid if includeAup = true example: null example: null aupSettings: properties: displayFrequency: title: displayFrequency type: string description: How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values firstLogin, everyLogin and recurring example: null includeAup: title: includeAup type: boolean description: Require the portal user to read and accept an AUP. example: null requireAupScrolling: title: requireAupScrolling type: boolean description: Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true. example: null displayFrequencyIntervalDays: title: displayFrequencyIntervalDays type: number description: Number of days between AUP confirmations (when displayFrequency = recurring). example: null example: null sponsorChangePasswordSettings: properties: allowSponsorToChangePwd: title: allowSponsorToChangePwd type: boolean description: Allow sponsors to change their own passwords. example: null example: null postLoginBannerSettings: properties: includePostAccessBanner: title: includePostAccessBanner type: boolean description: Include a Post-Login Banner page. example: null example: null supportInfoSettings: properties: includeSupportInfoPage: title: includeSupportInfoPage type: boolean description: '' example: null includeMacAddr: title: includeMacAddr type: boolean description: '' example: null includeIpAddress: title: includeIpAddress type: boolean description: '' example: null includeBrowserUserAgent: title: includeBrowserUserAgent type: boolean description: '' example: null includePolicyServer: title: includePolicyServer type: boolean description: '' example: null includeFailureCode: title: includeFailureCode type: boolean description: '' example: null emptyFieldDisplay: title: emptyFieldDisplay type: string description: 'Specifies how empty fields are handled on the Support Information Page. allowedValues: hide, displayWithNoValue and displayWithDefaultValue' example: null defaultEmptyFieldValue: title: defaultEmptyFieldValue type: string description: ' The default value displayed for an empty field Only valid when emptyFieldDisplay = displayWithDefaultValue. ' example: null example: null example: null customizations: properties: portalTheme: properties: id: title: id type: string description: The unique internal identifier of the portal theme. example: null name: title: name type: string description: The system- or user-assigned name of the portal theme. example: null themeData: title: themeData type: string description: A CSS file, represented as a Base64-encoded byte array. example: null example: null portalTweakSettings: properties: banneColor: title: banneColor type: string description: '' example: null bannerTextColor: title: bannerTextColor type: string description: '' example: null pageBackgroundColor: title: pageBackgroundColor type: string description: '' example: null pageLabelAndTextColor: title: pageLabelAndTextColor type: string description: '' example: null example: null language: title: language type: object description: This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported. example: null globalCustomizations: properties: bannerTitle: title: bannerTitle type: string description: '' example: null contactText: title: contactText type: string description: '' example: null footerElement: title: footerElement type: string description: '' example: null mobileLogoImage: properties: data: title: data type: string description: Represented as base 64 encoded string of the image byte array example: null example: null bannerImage: properties: data: title: data type: string description: Represented as base 64 encoded string of the image byte array example: null example: null backgroundImage: properties: data: title: data type: string description: Represented as base 64 encoded string of the image byte array example: null example: null example: null pageCustomizations: properties: data: title: data type: array description: The Dictionary will be exposed here as key value pair example: null items: properties: key: title: key type: string description: '' example: null value: title: value type: string description: '' example: null example: null 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 sponsorportalListResponseEntity: 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 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 SponsorPortal: required: - name - portalType properties: portalTestUrl: title: portalTestUrl type: string description: URL to bring up a test page for this portal example: null portalType: title: portalType type: string description: 'allowed values: byod, hotspotGuest, mydevice, selfRegGuest, sponsor and sponsoredGuest' example: null settings: properties: portalSettings: required: - allowedInterfaces - authenticationMethod - certificateGroupTag - httpsPort properties: httpsPort: title: httpsPort type: number description: The port number that the allowed interfaces will listen on. Range from 8000 to 8999 example: null allowedInterfaces: title: allowedInterfaces type: string description: 'Interfaces that the portal will be reachable on. allowed values: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1 and bond2' example: null certificateGroupTag: title: certificateGroupTag type: string description: Logical name of the x.509 server certificate that will be used for the portal. example: null fqdn: title: fqdn type: string description: The fully-qualified domain name (FQDN) that end-users will use to access this portal. Used only in Sponsor portal. example: null authenticationMethod: title: authenticationMethod type: string description: Unique Id of the identity source sequence . example: null idleTimeout: title: idleTimeout type: number description: '' example: null displayLang: title: displayLang type: string description: 'allowed values: useBrowserLocale and alwaysUse' example: null fallbackLanguage: title: fallbackLanguage type: string description: Used when displayLang = useBrowserLocale example: null alwaysUsedLanguage: title: alwaysUsedLanguage type: string description: Used when displayLang = alwaysUse example: null availableSsids: title: availableSsids type: string description: Names of the SSIDs available for assignment to guest users by sponsors. example: null example: null loginPageSettings: properties: maxFailedAttemptsBeforeRateLimit: title: maxFailedAttemptsBeforeRateLimit type: number description: Maximum failed login attempts before rate limiting. example: null timeBetweenLoginsDuringRateLimit: title: timeBetweenLoginsDuringRateLimit type: number description: Time between login attempts when rate limiting example: null includeAup: title: includeAup type: boolean description: Include an Acceptable Use Policy (AUP) that should be displayed during login. example: null aupDisplay: title: aupDisplay type: string description: How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values onPage and asLink example: null requireAupAcceptance: title: requireAupAcceptance type: boolean description: Require the portal user to accept the AUP. Only valid if includeAup = true example: null example: null aupSettings: properties: displayFrequency: title: displayFrequency type: string description: How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values firstLogin, everyLogin and recurring example: null includeAup: title: includeAup type: boolean description: Require the portal user to read and accept an AUP. example: null requireAupScrolling: title: requireAupScrolling type: boolean description: Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true. example: null displayFrequencyIntervalDays: title: displayFrequencyIntervalDays type: number description: Number of days between AUP confirmations (when displayFrequency = recurring). example: null example: null sponsorChangePasswordSettings: properties: allowSponsorToChangePwd: title: allowSponsorToChangePwd type: boolean description: Allow sponsors to change their own passwords. example: null example: null postLoginBannerSettings: properties: includePostAccessBanner: title: includePostAccessBanner type: boolean description: Include a Post-Login Banner page. example: null example: null supportInfoSettings: properties: includeSupportInfoPage: title: includeSupportInfoPage type: boolean description: '' example: null includeMacAddr: title: includeMacAddr type: boolean description: '' example: null includeIpAddress: title: includeIpAddress type: boolean description: '' example: null includeBrowserUserAgent: title: includeBrowserUserAgent type: boolean description: '' example: null includePolicyServer: title: includePolicyServer type: boolean description: '' example: null includeFailureCode: title: includeFailureCode type: boolean description: '' example: null emptyFieldDisplay: title: emptyFieldDisplay type: string description: 'Specifies how empty fields are handled on the Support Information Page. allowedValues: hide, displayWithNoValue and displayWithDefaultValue' example: null defaultEmptyFieldValue: title: defaultEmptyFieldValue type: string description: ' The default value displayed for an empty field Only valid when emptyFieldDisplay = displayWithDefaultValue. ' example: null example: null example: null customizations: properties: portalTheme: required: - name properties: id: title: id type: string description: The unique internal identifier of the portal theme. example: null name: title: name type: string description: The system- or user-assigned name of the portal theme. example: null themeData: title: themeData type: string description: A CSS file, represented as a Base64-encoded byte array. example: null example: null portalTweakSettings: properties: banneColor: title: banneColor type: string description: '' example: null bannerTextColor: title: bannerTextColor type: string description: '' example: null pageBackgroundColor: title: pageBackgroundColor type: string description: '' example: null pageLabelAndTextColor: title: pageLabelAndTextColor type: string description: '' example: null example: null language: title: language type: object description: This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported. example: null globalCustomizations: properties: bannerTitle: title: bannerTitle type: string description: '' example: null contactText: title: contactText type: string description: '' example: null footerElement: title: footerElement type: string description: '' example: null mobileLogoImage: properties: data: title: data type: string description: Represented as base 64 encoded string of the image byte array example: null example: null bannerImage: properties: data: title: data type: string description: Represented as base 64 encoded string of the image byte array example: null example: null backgroundImage: properties: data: title: data type: string description: Represented as base 64 encoded string of the image byte array example: null example: null example: null pageCustomizations: properties: data: title: data type: array description: The Dictionary will be exposed here as key value pair example: null items: properties: key: title: key type: string description: '' example: null value: title: value type: string description: '' example: null example: null 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: SponsorPortal: portalType: SPONSOR settings: loginPageSettings: maxFailedAttemptsBeforeRateLimit: 5 allowGuestToChangePassword: false requireAccessCode: false allowGuestToCreateAccounts: true includeAup: false allowAlternateGuestPortal: false socialConfigs: [] timeBetweenLoginsDuringRateLimit: 2 allowShowGuestForm: false allowForgotPassword: true allowGuestToUseSocialAccounts: false requireAupAcceptance: false requireAupScrolling: false aupDisplay: ASLINK supportInfoSettings: includePolicyServer: true includeFailureCode: true includeMacAddr: true includeBrowserUserAgent: true includeSupportInfoPage: false includeIpAddress: true emptyFieldDisplay: HIDE aupSettings: requireAccessCode: false requireScrolling: true includeAup: false useDiffAupForEmployees: false displayFrequency: FIRSTLOGIN skipAupForEmployees: false postLoginBannerSettings: includePostAccessBanner: true portalSettings: allowedInterfaces: - eth0 - bond0 fqdn: Fully Qualified Domain Name authenticationMethod: Identity Source availableSsids: - ssid1 - ssid2 certificateGroupTag: Default Portal Certificate Group idleTimeout: 10 alwaysUsedLanguage: English displayLang: USEBROWSERLOCALE fallbackLanguage: English httpsPort: 8443 sponsorChangePasswordSettings: allowSponsorToChangePwd: 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 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