Cisco Identity Services Engine Guestsmtpnotificationsettings API

openapi: 3.2.0
info:
  title: ISE ERS Guestsmtpnotificationsettings 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: guestsmtpnotificationsettings
paths:
  /guestsmtpnotificationsettings/:
    get:
      tags:
      - guestsmtpnotificationsettings
      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/guestsmtpnotificationsettingsListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/guestsmtpnotificationsettingsListResponse'
            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:
      - guestsmtpnotificationsettings
      summary: Create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.guestsmtpnotificationsettings'
            example:
              ERSGuestSmtpNotificationSettings:
                password: ''
                smtpServer: ''
                useDefaultFromAddress: false
                defaultFromAddress: donotreply@example.com
                smtpPort: '25'
                useTLSorSSLEncryption: false
                userName: ''
                connectionTimeout: '60'
                notificationEnabled: true
                usePasswordAuthentication: false
        required: true
      responses:
        '201':
          description: Created
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '406':
          description: Not Acceptable
        '415':
          description: UnSupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '500':
          description: Internal Server Error
  /guestsmtpnotificationsettings/{id}:
    get:
      tags:
      - guestsmtpnotificationsettings
      summary: Get-By-Id
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/guestsmtpnotificationsettingsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/guestsmtpnotificationsettingsResponse'
            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:
      - guestsmtpnotificationsettings
      summary: Update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.guestsmtpnotificationsettings'
            example:
              ERSGuestSmtpNotificationSettings:
                password: ''
                smtpServer: ''
                useDefaultFromAddress: false
                defaultFromAddress: donotreply@example.com
                smtpPort: '25'
                useTLSorSSLEncryption: false
                userName: ''
                connectionTimeout: '60'
                notificationEnabled: true
                usePasswordAuthentication: false
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatedFieldsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/UpdatedFieldsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '406':
          description: Not Acceptable
        '415':
          description: UnSupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '500':
          description: Internal Server Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
    patch:
      tags:
      - guestsmtpnotificationsettings
      summary: Patch
      description: Update any attribute subset. Only attributes that sent will be affected.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.guestsmtpnotificationsettings'
            example:
              ERSGuestSmtpNotificationSettings:
                password: ''
                smtpServer: ''
                useDefaultFromAddress: false
                defaultFromAddress: donotreply@example.com
                smtpPort: '25'
                useTLSorSSLEncryption: false
                userName: ''
                connectionTimeout: '60'
                notificationEnabled: true
                usePasswordAuthentication: false
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/guestsmtpnotificationsettingsResponse'
        '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
    guestsmtpnotificationsettingsListResponseEntity:
      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
    guestsmtpnotificationsettingsResponse:
      type: object
      properties:
        ERSGuestSmtpNotificationSettings:
          $ref: '#/components/schemas/guestsmtpnotificationsettingsResponseEntity'
      example:
        ERSGuestSmtpNotificationSettings:
          password: ''
          smtpServer: ''
          useDefaultFromAddress: false
          defaultFromAddress: donotreply@example.com
          smtpPort: '25'
          useTLSorSSLEncryption: false
          userName: ''
          connectionTimeout: '60'
          notificationEnabled: true
          usePasswordAuthentication: false
    guestsmtpnotificationsettingsListResponse:
      type: object
      properties:
        SearchResult:
          type: object
          properties:
            total:
              type: integer
              example: '2'
            resources:
              type: array
              example: null
              items:
                $ref: '#/components/schemas/guestsmtpnotificationsettingsListResponseEntity'
          example: null
      example:
        SearchResult:
          total: 2
          previousPage:
            rel: previous
            href: link-to-previous-page
            type: application/xml
          nextPage:
            rel: next
            href: link-to-next-page
            type: application/xml
          resources:
          - name: name1
            link:
              rel: self
              href: <url to resource name1>
              type: application/xml
            description: description1
            id: id1
          - name: name2
            link:
              rel: self
              href: <url to resource name2>
              type: application/xml
            description: description2
            id: id2
    identity.guestsmtpnotificationsettings:
      required:
      - ERSGuestSmtpNotificationSettings
      type: object
      properties:
        ERSGuestSmtpNotificationSettings:
          $ref: '#/components/schemas/ERSGuestSmtpNotificationSettings'
      example: null
    ERSGuestSmtpNotificationSettings:
      properties:
        defaultFromAddress:
          title: defaultFromAddress
          type: string
          description: the default From email address to be used to send emails from
          example: null
        notificationEnabled:
          title: notificationEnabled
          type: boolean
          description: indicates if the email notification service is to be enabled
          example: null
        smtpServer:
          title: smtpServer
          type: string
          description: the SMTP server ip address or fqdn such as outbound.mycompany.com
          example: null
        useDefaultFromAddress:
          title: useDefaultFromAddress
          type: boolean
          description: if the default from address should be used rather than using a sponsor user email address
          example: null
        smtpPort:
          title: smtpPort
          type: string
          description: Port at which SMTP Secure Server is listening
          example: null
        connectionTimeout:
          title: connectionTimeout
          type: string
          description: Interval in seconds for all the SMTP client connections
          example: null
        useTLSorSSLEncryption:
          title: useTLSorSSLEncryption
          type: boolean
          description: If configured to true, SMTP server authentication will happen using TLS/SSL
          example: null
        usePasswordAuthentication:
          title: usePasswordAuthentication
          type: boolean
          description: If configured to true, SMTP server authentication will happen using username/password
          example: null
        userName:
          title: userName
          type: string
          description: Username of Secure SMTP server
          example: null
        password:
          title: password
          type: string
          description: Password of Secure SMTP server
          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:
        ERSGuestSmtpNotificationSettings:
          password: ''
          smtpServer: ''
          useDefaultFromAddress: false
          defaultFromAddress: donotreply@example.com
          smtpPort: '25'
          useTLSorSSLEncryption: false
          userName: ''
          connectionTimeout: '60'
          notificationEnabled: true
          usePasswordAuthentication: false
    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
    guestsmtpnotificationsettingsResponseEntity:
      properties:
        defaultFromAddress:
          title: defaultFromAddress
          type: string
          description: the default From email address to be used to send emails from
          example: null
        notificationEnabled:
          title: notificationEnabled
          type: boolean
          description: indicates if the email notification service is to be enabled
          example: null
        smtpServer:
          title: smtpServer
          type: string
          description: the SMTP server ip address or fqdn such as outbound.mycompany.com
          example: null
        useDefaultFromAddress:
          title: useDefaultFromAddress
          type: boolean
          description: if the default from address should be used rather than using a sponsor user email address
          example: null
        smtpPort:
          title: smtpPort
          type: string
          description: Port at which SMTP Secure Server is listening
          example: null
        connectionTimeout:
          title: connectionTimeout
          type: string
          description: Interval in seconds for all the SMTP client connections
          example: null
        useTLSorSSLEncryption:
          title: useTLSorSSLEncryption
          type: boolean
          description: If configured to true, SMTP server authentication will happen using TLS/SSL
          example: null
        usePasswordAuthentication:
          title: usePasswordAuthentication
          type: boolean
          description: If configured to true, SMTP server authentication will happen using username/password
          example: null
        userName:
          title: userName
          type: string
          description: Username of Secure SMTP server
          example: null
        password:
          title: password
          type: string
          description: Password of Secure SMTP server
          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
    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