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: 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/selfregportalResponse' '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' 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 selfregportalResponseEntity: 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 authenticationMethod: title: authenticationMethod type: string description: Unique Id of the identity source sequence . example: null assignedGuestTypeForEmployee: title: assignedGuestTypeForEmployee type: string description: Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type. 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 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 requireAccessCode: title: requireAccessCode type: boolean description: Require the portal user to enter an access code. example: null accessCode: title: accessCode type: string description: Access code that must be entered by the portal user (only valid if requireAccessCode = true). example: null allowGuestToCreateAccounts: title: allowGuestToCreateAccounts type: boolean description: '' example: null allowGuestToChangePassword: title: allowGuestToChangePassword type: boolean description: Require the portal user to enter an access code. example: null allowAlternateGuestPortal: title: allowAlternateGuestPortal type: boolean description: '' example: null alternateGuestPortal: title: alternateGuestPortal type: string description: '' example: null example: null selfRegPageSettings: properties: assignGuestsToGuestType: title: assignGuestsToGuestType type: string description: guests are assigned to this guest type example: null accountValidityDuration: title: accountValidityDuration type: number description: Self-registered guest account is valid for this many account_validity_time_units example: null accountValidityTimeUnits: title: accountValidityTimeUnits type: string description: Time units for account_validity_duration. Allowed Values days, hours and minutes example: null requireRegistrationCode: title: requireRegistrationCode type: boolean description: Self-registered guests are required to enter a registration code. example: null registrationCode: title: registrationCode type: string description: The registration code that the guest user must enter. example: null fieldUserName: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldFirstName: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldLastName: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldEmailAddr: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldPhoneNo: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldCompany: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldLocation: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null selectableLocations: title: selectableLocations type: array description: Guests can choose from these locations to set their time zone example: null items: type: string example: null fieldSmsProvider: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null selectableSmsProviders: title: selectableSmsProviders type: array description: This attribute is an array of SMS provider names example: null items: type: string example: null fieldPersonBeingVisited: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldReasonForVisit: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null 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 enableGuestEmailAllowlist: title: enableGuestEmailAllowlist type: boolean description: Allow guests with an e-mail address from selected domains. example: null guestEmailAllowlistDomains: title: guestEmailAllowlistDomains type: array description: 'Self-registered guests whose e-mail address is in one of these domains will be allowed. Only valid if enableGuestEmailWhitelist = true. ' example: null items: type: string example: null enableGuestEmailBlocklist: title: enableGuestEmailBlocklist type: boolean description: Disallow guests with an e-mail address from selected domains. example: null guestEmailBlocklistDomains: title: guestEmailBlocklistDomains type: array description: 'Self-registered guests whose e-mail address is in one of these domains will be disallowed. Only valid if enableGuestEmailBlacklist = true. ' example: null items: type: string example: null requireGuestApproval: title: requireGuestApproval type: boolean description: Require self-registered guests to be approved if true. example: null autoLoginSelfWait: title: autoLoginSelfWait type: boolean description: Allow guests to login automatically from self-registration after sponsor's approval. No need to provide the credentials by guest to login. example: null autoLoginTimePeriod: title: autoLoginTimePeriod type: object description: Waiting period for auto login until sponsor's approval. If time exceeds, guest has to login manually by providing the credentials. Default value is 5 minutes. example: null sendApprovalRequestTo: title: sendApprovalRequestTo type: string description: Specifies where approval requests are sent. Only valid if requireGuestApproval = true. Allowed Values selectedEmailAddresses and personBeingVisited example: null approvalEmailAddresses: title: approvalEmailAddresses type: string description: Only valid if requireGuestApproval = true and sendApprovalRequestTo = selectedEmailAddresses example: null postRegistrationRedirect: title: postRegistrationRedirect type: string description: After the registration submission direct the guest user to one of the following pages. Only valid if requireGuestApproval = true. Allowed Values selfRegistrationSuccess, loginPageWithInstructions and url example: null postRegistrationRedirectUrl: title: postRegistrationRedirectUrl type: string description: ' URL where guest user is redirected after registration. Only valid if requireGuestApproval = true and postRegistrationRedirect = url' example: null credentialNotificationUsingEmail: title: credentialNotificationUsingEmail type: boolean description: If true, send credential notification upon approval using email. Only valid if requireGuestApproval = true example: null credentialNotificationUsingSms: title: credentialNotificationUsingSms type: boolean description: If true, send credential notification upon approval using SMS. Only valid if requireGuestApproval = true example: null approveDenyLinksValidFor: title: approveDenyLinksValidFor type: number description: ' This attribute, along with approveDenyLinksTimeUnits, specifies how long the link can be used. Only valid if requireGuestApproval = true.' example: null approveDenyLinksTimeUnits: title: approveDenyLinksTimeUnits type: string description: ' This attribute, along with approveDenyLinksValidFor, specifies how long the link can be used. Only valid if requireGuestApproval = true. Allowed Values days, hours and minutes' example: null requireApproverToAuthenticate: title: requireApproverToAuthenticate type: boolean description: When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be required to enter their username and password if this attribute is true. Only valid if requireGuestApproval = true example: null sponsorPortalList: title: sponsorPortalList type: array description: When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be authenticated against the selected sponsor portals in the order specified. Only valid if requireGuestApproval = true. The array should contain the names of the selected portals example: null items: type: string example: null example: null selfRegSuccessSettings: properties: includeUserName: title: includeUserName type: boolean description: '' example: null includePassword: title: includePassword type: boolean description: '' example: null includeFirstName: title: includeFirstName type: boolean description: '' example: null includeLastName: title: includeLastName type: boolean description: '' example: null includeEmailAddr: title: includeEmailAddr type: boolean description: '' example: null includePhoneNo: title: includePhoneNo type: boolean description: '' example: null includeCompany: title: includeCompany type: boolean description: '' example: null includeLocation: title: includeLocation type: boolean description: '' example: null includeSmsProvider: title: includeSmsProvider type: boolean description: '' example: null includePersonBeingVisited: title: includePersonBeingVisited type: boolean description: '' example: null includeReasonForVisit: title: includeReasonForVisit type: boolean description: '' example: null allowGuestSendSelfUsingPrint: title: allowGuestSendSelfUsingPrint type: boolean description: '' example: null allowGuestSendSelfUsingEmail: title: allowGuestSendSelfUsingEmail type: boolean description: '' example: null allowGuestSendSelfUsingSms: title: allowGuestSendSelfUsingSms type: boolean description: '' example: null includeAup: title: includeAup type: boolean description: '' example: null aupOnPage: title: aupOnPage type: boolean description: '' example: null requireAupAcceptance: title: requireAupAcceptance type: boolean description: '' example: null requireAupScrolling: title: requireAupScrolling type: boolean description: '' example: null allowGuestLoginFromSelfregSuccessPage: title: allowGuestLoginFromSelfregSuccessPage type: boolean description: '' 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 useDiffAupForEmployees: title: useDiffAupForEmployees type: boolean description: ' Only valid if requireAupAcceptance = true.' example: null skipAupForEmployees: title: skipAupForEmployees type: boolean description: ' 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 guestChangePasswordSettings: properties: allowChangePasswdAtFirstLogin: title: allowChangePasswdAtFirstLogin type: boolean description: Allow guest to change their own passwords. example: null example: null guestDeviceRegistrationSettings: properties: autoRegisterGuestDevices: title: autoRegisterGuestDevices type: boolean description: 'Automatically register guest devices ' example: null allowGuestsToRegisterDevices: title: allowGuestsToRegisterDevices type: boolean description: Allow guests to register devices. example: null example: null byodSettings: properties: byodWelcomeSettings: properties: enableBYOD: title: enableBYOD type: boolean description: '' example: null enableGuestAccess: title: enableGuestAccess type: boolean description: '' example: null requireMDM: title: requireMDM type: boolean description: '' example: null includeAup: title: includeAup type: boolean description: '' 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. allowedValues: onPage, asLink' example: null requireAupAcceptance: title: requireAupAcceptance type: boolean description: '' example: null requireScrolling: title: requireScrolling type: boolean description: Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true example: null example: null byodRegistrationSettings: properties: showDeviceID: title: showDeviceID type: boolean description: Display Device ID field during registration. example: null endPointIdentityGroupId: title: endPointIdentityGroupId type: string description: TIdentity group id for which endpoint belongs. example: null example: null byodRegistrationSuccessSettings: properties: successRedirect: title: successRedirect type: string description: 'After an Authentication Success where should device be redirected, allowedValues: authSuccessPage, originatingURL and url' example: null redirectUrl: title: redirectUrl type: string description: Target URL for redirection, used when successRedirect = url example: null example: null example: null authSuccessSettings: properties: successRedirect: title: successRedirect type: string description: After an Authentication Success where should user be redirected. Allowed Values authSuccessPage, originatingURL and url. example: null redirectUrl: title: redirectUrl type: string description: Target URL for redirection, used when successRedirect = url 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 selfregportalListResponseEntity: 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 updatedField: properties: field: type: string example: null oldValue: type: string example: null newValue: type: string example: null example: null SelfRegPortal: 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 - assignedGuestTypeForEmployee - 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 authenticationMethod: title: authenticationMethod type: string description: Unique Id of the identity source sequence . example: null assignedGuestTypeForEmployee: title: assignedGuestTypeForEmployee type: string description: Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type. 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 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 requireAccessCode: title: requireAccessCode type: boolean description: Require the portal user to enter an access code. example: null accessCode: title: accessCode type: string description: Access code that must be entered by the portal user (only valid if requireAccessCode = true). example: null allowGuestToCreateAccounts: title: allowGuestToCreateAccounts type: boolean description: '' example: null allowGuestToChangePassword: title: allowGuestToChangePassword type: boolean description: Require the portal user to enter an access code. example: null allowAlternateGuestPortal: title: allowAlternateGuestPortal type: boolean description: '' example: null alternateGuestPortal: title: alternateGuestPortal type: string description: '' example: null example: null selfRegPageSettings: properties: assignGuestsToGuestType: title: assignGuestsToGuestType type: string description: guests are assigned to this guest type example: null accountValidityDuration: title: accountValidityDuration type: number description: Self-registered guest account is valid for this many account_validity_time_units example: null accountValidityTimeUnits: title: accountValidityTimeUnits type: string description: Time units for account_validity_duration. Allowed Values days, hours and minutes example: null requireRegistrationCode: title: requireRegistrationCode type: boolean description: Self-registered guests are required to enter a registration code. example: null registrationCode: title: registrationCode type: string description: The registration code that the guest user must enter. example: null fieldUserName: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldFirstName: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldLastName: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldEmailAddr: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldPhoneNo: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldCompany: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldLocation: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null selectableLocations: title: selectableLocations type: array description: Guests can choose from these locations to set their time zone example: null items: type: string example: null fieldSmsProvider: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null selectableSmsProviders: title: selectableSmsProviders type: array description: This attribute is an array of SMS provider names example: null items: type: string example: null fieldPersonBeingVisited: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null example: null fieldReasonForVisit: properties: include: title: include type: boolean description: '' example: null displayFrequency: title: displayFrequency type: boolean description: Only applicable if include = true. example: null 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 enableGuestEmailAllowlist: title: enableGuestEmailAllowlist type: boolean description: Allow guests with an e-mail address from selected domains. example: null guestEmailAllowlistDomains: title: guestEmailAllowlistDomains type: array description: 'Self-registered guests whose e-mail address is in one of these domains will be allowed. Only valid if enableGuestEmailWhitelist = true. ' example: null items: type: string example: null enableGuestEmailBlocklist: title: enableGuestEmailBlocklist type: boolean description: Disallow guests with an e-mail address from selected domains. example: null guestEmailBlocklistDomains: title: guestEmailBlocklistDomains type: array description: 'Self-registered guests whose e-mail address is in one of these domains will be disallowed. Only valid if enableGuestEmailBlacklist = true. ' example: null items: type: string example: null requireGuestApproval: title: requireGuestApproval type: boolean description: Require self-registered guests to be approved if true. example: null autoLoginSelfWait: title: autoLoginSelfWait type: boolean description: Allow guests to login automatically from self-registration after sponsor's approval. No need to provide the credentials by guest to login. example: null autoLoginTimePeriod: title: autoLoginTimePeriod type: object description: Waiting period for auto login until sponsor's approval. If time exceeds, guest has to login manually by providing the credentials. Default value is 5 minutes. example: null sendApprovalRequestTo: title: sendApprovalRequestTo type: string description: Specifies where approval requests are sent. Only valid if requireGuestApproval = true. Allowed Values selectedEmailAddresses and personBeingVisited example: null approvalEmailAddresses: title: approvalEmailAddresses type: string description: Only valid if requireGuestApproval = true and sendApprovalRequestTo = selectedEmailAddresses example: null postRegistrationRedirect: title: postRegistrationRedirect type: string description: After the registration submission direct the guest user to one of the following pages. Only valid if requireGuestApproval = true. Allowed Values selfRegistrationSuccess, loginPageWithInstructions and url example: null postRegistrationRedirectUrl: title: postRegistrationRedirectUrl type: string description: ' URL where guest user is redirected after registration. Only valid if requireGuestApproval = true and postRegistrationRedirect = url' example: null credentialNotificationUsingEmail: title: credentialNotificationUsingEmail type: boolean description: If true, send credential notification upon approval using email. Only valid if requireGuestApproval = true example: null credentialNotificationUsingSms: title: credentialNotificationUsingSms type: boolean description: If true, send credential notification upon approval using SMS. Only valid if requireGuestApproval = true example: null approveDenyLinksValidFor: title: approveDenyLinksValidFor type: number description: ' This attribute, along with approveDenyLinksTimeUnits, specifies how long the link can be used. Only valid if requireGuestApproval = true.' example: null approveDenyLinksTimeUnits: title: approveDenyLinksTimeUnits type: string description: ' This attribute, along with approveDenyLinksValidFor, specifies how long the link can be used. Only valid if requireGuestApproval = true. Allowed Values days, hours and minutes' example: null requireApproverToAuthenticate: title: requireApproverToAuthenticate type: boolean description: When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be required to enter their username and password if this attribute is true. Only valid if requireGuestApproval = true example: null sponsorPortalList: title: sponsorPortalList type: array description: When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be authenticated against the selected sponsor portals in the order specified. Only valid if requireGuestApproval = true. The array should contain the names of the selected portals example: null items: type: string example: null example: null selfRegSuccessSettings: properties: includeUserName: title: includeUserName type: boolean description: '' example: null includePassword: title: includePassword type: boolean description: '' example: null includeFirstName: title: includeFirstName type: boolean description: '' example: null includeLastName: title: includeLastName type: boolean description: '' example: null includeEmailAddr: title: includeEmailAddr type: boolean description: '' example: null includePhoneNo: title: includePhoneNo type: boolean description: '' example: null includeCompany: title: includeCompany type: boolean description: '' example: null includeLocation: title: includeLocation type: boolean description: '' example: null includeSmsProvider: title: includeSmsProvider type: boolean description: '' example: null includePersonBeingVisited: title: includePersonBeingVisited type: boolean description: '' example: null includeReasonForVisit: title: includeReasonForVisit type: boolean description: '' example: null allowGuestSendSelfUsingPrint: title: allowGuestSendSelfUsingPrint type: boolean description: '' example: null allowGuestSendSelfUsingEmail: title: allowGuestSendSelfUsingEmail type: boolean description: '' example: null allowGuestSendSelfUsingSms: title: allowGuestSendSelfUsingSms type: boolean description: '' example: null includeAup: title: includeAup type: boolean description: '' example: null aupOnPage: title: aupOnPage type: boolean description: '' example: null requireAupAcceptance: title: requireAupAcceptance type: boolean description: '' example: null requireAupScrolling: title: requireAupScrolling type: boolean description: '' example: null allowGuestLoginFromSelfregSuccessPage: title: allowGuestLoginFromSelfregSuccessPage type: boolean description: '' 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 useDiffAupForEmployees: title: useDiffAupForEmployees type: boolean description: ' Only valid if requireAupAcceptance = true.' example: null skipAupForEmployees: title: skipAupForEmployees type: boolean description: ' 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 guestChangePasswordSettings: properties: allowChangePasswdAtFirstLogin: title: allowChangePasswdAtFirstLogin type: boolean description: Allow guest to change their own passwords. example: null example: null guestDeviceRegistrationSettings: properties: autoRegisterGuestDevices: title: autoRegisterGuestDevices type: boolean description: 'Automatically register guest devices ' example: null allowGuestsToRegisterDevices: title: allowGuestsToRegisterDevices type: boolean description: Allow guests to register devices. example: null example: null byodSettings: properties: byodWelcomeSettings: properties: enableBYOD: title: enableBYOD type: boolean description: '' example: null enableGuestAccess: title: enableGuestAccess type: boolean description: '' example: null requireMDM: title: requireMDM type: boolean description: '' example: null includeAup: title: includeAup type: boolean description: '' 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. allowedValues: onPage, asLink' example: null requireAupAcceptance: title: requireAupAcceptance type: boolean description: '' example: null requireScrolling: title: requireScrolling type: boolean description: Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true example: null example: null byodRegistrationSettings: properties: showDeviceID: title: showDeviceID type: boolean description: Display Device ID field during registration. example: null endPointIdentityGroupId: title: endPointIdentityGroupId type: string description: TIdentity group id for which endpoint belongs. example: null example: null byodRegistrationSuccessSettings: properties: successRedirect: title: successRedirect type: string description: 'After an Authentication Success where should device be redirected, allowedValues: authSuccessPage, originatingURL and url' example: null redirectUrl: title: redirectUrl type: string description: Target URL for redirection, used when successRedirect = url example: null example: null example: null authSuccessSettings: properties: successRedirect: title: successRedirect type: string description: After an Authentication Success where should user be redirected. Allowed Values authSuccessPage, originatingURL and url. example: null redirectUrl: title: redirectUrl type: string description: Target URL for redirection, used when successRedirect = url 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: 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 selfregportalListResponse: type: object properties: SearchResult: type: object properties: total: type: integer example: '2' resources: type: array example: null items: $ref: '#/components/schemas/selfregportalListResponseEntity' 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 selfregportalResponse: type: object properties: SelfRegPortal: $ref: '#/components/schemas/selfregportalResponseEntity' 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 portal.selfregportal: required: - SelfRegPortal type: object properties: SelfRegPortal: $ref: '#/components/schemas/SelfRegPortal' 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 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