openapi: 3.2.0
info:
  title: ISE ERS Guestuser 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: guestuser
paths:
  /guestuser/:
    get:
      tags:
      - guestuser
      summary: Get-All
      parameters:
      - name: filter
        in: query
        description: Filter Supported Fields:[lastName, sponsor, creationTime, personBeingVisited, toDate, userName, firstName, emailAddress, phoneNumber, groupTag, name, company, guestType, status]
        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:[firstName, lastName, emailAddress, name, description]
        required: false
        allowReserved: true
        schema:
          example: null
          enum:
          - firstName
          - lastName
          - emailAddress
          - name
          - description
      - name: sortasc
        in: query
        description: Sorting Supported Fields:[firstName, lastName, emailAddress, name, description]
        required: false
        allowReserved: true
        schema:
          example: null
          enum:
          - firstName
          - lastName
          - emailAddress
          - name
          - description
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/guestuserListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/guestuserListResponse'
            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:
      - guestuser
      summary: Create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.guestuser'
            example:
              GuestUser:
                sponsorUserName: Mr Spons
                guestAccessInfo:
                  fromDate: 07/29/2014 14:44
                  toDate: 10/29/2014 17:30
                  location: San Jose
                  validDays: 90
                customFields:
                  another key: and its value
                  some key: some value
                portalId: '23423432523'
                name: guestUser
                description: 'ERS Example user '
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
                guestInfo:
                  emailAddress: email@some.uri.com
                  password: asdlkj324ew
                  phoneNumber: '+13211239034'
                  smsServiceProvider: GLobal Default
                  userName: DS3ewdsa34wWE
                  enabled: true
                guestType: Contractor
        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
  /guestuser/deny/{id}:
    put:
      tags:
      - guestuser
      summary: deny
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '406':
          description: Not Acceptable
        '415':
          description: UnSupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
  /guestuser/suspend/{id}:
    put:
      tags:
      - guestuser
      summary: suspendById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationAdditionalDataEntity'
        required: true
      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
        '500':
          description: Internal Server Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
  /guestuser/approve/{id}:
    put:
      tags:
      - guestuser
      summary: approve
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '406':
          description: Not Acceptable
        '415':
          description: UnSupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
  /guestuser/name/{name}:
    get:
      tags:
      - guestuser
      summary: Get-By-Name
      parameters:
      - name: name
        in: path
        required: true
        schema:
          title: name
          type: string
          example: null
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/guestuserResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/guestuserResponse'
            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:
      - guestuser
      summary: UpdateByName
      parameters:
      - name: name
        in: path
        required: true
        schema:
          title: name
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.guestuser'
            example:
              GuestUser:
                sponsorUserName: Mr Spons
                guestAccessInfo:
                  fromDate: 07/29/2014 14:44
                  toDate: 10/29/2014 17:30
                  location: San Jose
                  validDays: 90
                customFields:
                  another key: and its value
                  some key: some value
                portalId: '23423432523'
                name: guestUser
                description: 'ERS Example user '
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
                guestInfo:
                  emailAddress: email@some.uri.com
                  password: asdlkj324ew
                  phoneNumber: '+13211239034'
                  smsServiceProvider: GLobal Default
                  userName: DS3ewdsa34wWE
                  enabled: true
                guestType: Contractor
        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:
      - guestuser
      summary: DeleteByName
      parameters:
      - name: name
        in: path
        required: true
        schema:
          title: name
          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
  /guestuser/sms/{id}/portalId/{portalId}:
    put:
      tags:
      - guestuser
      summary: sms
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      - name: portalId
        in: path
        required: true
        schema:
          title: portalId
          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
  /guestuser/changeSponsorPassword/{portalId}:
    put:
      tags:
      - guestuser
      summary: changeSponsorPassword
      parameters:
      - name: portalId
        in: path
        required: true
        schema:
          title: portalId
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationAdditionalDataEntity'
        required: true
      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
        '500':
          description: Internal Server Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
  /guestuser/resetpassword/{id}:
    put:
      tags:
      - guestuser
      summary: resetpassword
      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/OperationResultEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/OperationResultEntity'
            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
        '500':
          description: Internal Server Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
  /guestuser/email/{id}/portalId/{portalId}:
    put:
      tags:
      - guestuser
      summary: email
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      - name: portalId
        in: path
        required: true
        schema:
          title: portalId
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.guestuser'
            example:
              GuestUser:
                sponsorUserName: Mr Spons
                guestAccessInfo:
                  fromDate: 07/29/2014 14:44
                  toDate: 10/29/2014 17:30
                  location: San Jose
                  validDays: 90
                customFields:
                  another key: and its value
                  some key: some value
                portalId: '23423432523'
                name: guestUser
                description: 'ERS Example user '
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
                guestInfo:
                  emailAddress: email@some.uri.com
                  password: asdlkj324ew
                  phoneNumber: '+13211239034'
                  smsServiceProvider: GLobal Default
                  userName: DS3ewdsa34wWE
                  enabled: true
                guestType: Contractor
        required: true
      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
        '500':
          description: Internal Server Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
  /guestuser/reinstate/{id}:
    put:
      tags:
      - guestuser
      summary: reinstateById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '406':
          description: Not Acceptable
        '415':
          description: UnSupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
  /guestuser/reinstate/name/{name}:
    put:
      tags:
      - guestuser
      summary: reinstateByName
      parameters:
      - name: name
        in: path
        required: true
        schema:
          title: name
          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
  /guestuser/suspend/name/{name}:
    put:
      tags:
      - guestuser
      summary: suspendByName
      parameters:
      - name: name
        in: path
        required: true
        schema:
          title: name
          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
  /guestuser/{id}:
    get:
      tags:
      - guestuser
      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/guestuserResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/guestuserResponse'
            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:
      - guestuser
      summary: UpdateById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/identity.guestuser'
            example:
              GuestUser:
                sponsorUserName: Mr Spons
                guestAccessInfo:
                  fromDate: 07/29/2014 14:44
                  toDate: 10/29/2014 17:30
                  location: San Jose
                  validDays: 90
                customFields:
                  another key: and its value
                  some key: some value
                portalId: '23423432523'
                name: guestUser
                description: 'ERS Example user '
                id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
                guestInfo:
                  emailAddress: email@some.uri.com
                  password: asdlkj324ew
                  phoneNumber: '+13211239034'
                  smsServiceProvider: GLobal Default
                  userName: DS3ewdsa34wWE
                  enabled: true
                guestType: Contractor
        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:
      - guestuser
      summary: DeleteById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          title: id
          type: string
          example: null
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
        '406':
          description: Not Acceptable
        '415':
          description: UnSupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/ERSResponse'
            text/html:
              schema:
                type: string
                example: null
components:
  schemas:
    Link:
      type: object
      properties:
        rel:
          type: string
          example: self
          enum:
          - next
          - previous
          - self
          - status
        href:
          type: string
          example: https://{server}:{port}/ers/config
        type:
          type: string
          example: application/json
      example: null
    identity.guestuser:
      required:
      - GuestUser
      type: object
      properties:
        GuestUser:
          $ref: '#/components/schemas/GuestUser'
      example: null
    OperationAdditionalDataEntity:
      properties:
        OperationAdditionalData:
          properties:
            additionalData:
              type: array
              example: null
              items:
                properties:
                  value:
                    type: string
                    example: null
                  name:
                    type: string
                    example: null
                example: null
          example: null
      example: null
    GuestUser:
      required:
      - name
      - portalId
      properties:
        customFields:
          title: customFields
          type: object
          description: Key value map
          example: null
        guestType:
          title: guestType
          type: string
          description: ''
          example: null
        status:
          title: status
          type: string
          description: This field is applicable only for Get operation not applicable for Create and Update operations.
          example: null
        reasonForVisit:
          title: reasonForVisit
          type: string
          description: ''
          example: null
        personBeingVisited:
          title: personBeingVisited
          type: string
          description: ''
          example: null
        sponsorUserName:
          title: sponsorUserName
          type: string
          description: This field is applicable for Get and Create operations not applicable for Update operation.
          example: null
        sponsorUserId:
          title: sponsorUserId
          type: string
          description: This field is applicable only for Get operation not applicable for Create and Update operations.
          example: null
        statusReason:
          title: statusReason
          type: string
          description: ''
          example: null
        portalId:
          title: portalId
          type: string
          description: This field is applicable only for Create and Update operations not applicable for Get operation.<br/>Portal ID will be used to fetch configuration from Portal if missing from the Payload. For example Notification Language will be fetched from Portal if missing.
          example: null
        guestAccessInfo:
          required:
          - validDays
          properties:
            validDays:
              title: validDays
              type: object
              description: Number of days guest user is valid. To validate validDays property, ISE consider only date(not time) between fromDate and toDate properites.
              example: null
            fromDate:
              title: fromDate
              type: string
              description: ''
              example: null
            toDate:
              title: toDate
              type: string
              description: ''
              example: null
            location:
              title: location
              type: string
              description: ''
              example: null
            ssid:
              title: ssid
              type: string
              description: ''
              example: null
            groupTag:
              title: groupTag
              type: string
              description: ''
              example: null
          example: null
        guestInfo:
          required:
          - enabled
          - password
          properties:
            emailAddress:
              title: emailAddress
              type: string
              description: ''
              example: null
            enabled:
              title: enabled
              type: boolean
              description: This field is only for Get operation not applicable for Create, Update operations.
              example: null
            password:
              title: password
              type: string
              description: ''
              example: null
            phoneNumber:
              title: phoneNumber
              type: string
              description: Phone number should be E.164 format.
              example: null
            smsServiceProvider:
              title: smsServiceProvider
              type: string
              description: ''
              example: null
            userName:
              title: userName
              type: string
              description: This field is applicable for Get and Create operations not applicable for Update operation.<br/>If account needs be created with mobile number, please provide mobile number here
              example: null
            firstName:
              title: firstName
              type: string
              description: ''
              example: null
            lastName:
              title: lastName
              type: string
              description: ''
              example: null
            company:
              title: company
              type: string
              description: ''
              example: null
            creationTime:
              title: creationTime
              type: string
              description: ''
              example: null
            notificationLanguage:
              title: notificationLanguage
              type: string
              description: ''
              example: null
          example: null
        name:
          title: name
          type: string
          description: name
          example: null
        id:
          title: id
          type: string
          description: Id
          example: null
        description:
          title: description
          type: string
          description: Description
          example: null
      example:
        GuestUser:
          sponsorUserName: Mr Spons
          guestAccessInfo:
            fromDate: 07/29/2014 14:44
            toDate: 10/29/2014 17:30
            location: San Jose
            validDays: 90
          customFields:
            another key: and its value
            some key: some value
          portalId: '23423432523'
          name: guestUser
          description: 'ERS Example user '
          id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
          guestInfo:
            emailAddress: email@some.uri.com
            password: asdlkj324ew
            phoneNumber: '+13211239034'
            smsServiceProvider: GLobal Default
            userName: DS3ewdsa34wWE
            enabled: true
          guestType: Contractor
    updatedField:
      properties:
        field:
          type: string
          example: null
        oldValue:
          type: string
          example: null
        newValue:
          type: string
          example: null
      example: null
    OperationResultEntity:
      properties:
        OperationResult:
          properties:
            resultValue:
              type: array
              example: null
              items:
                properties:
                  Value:
                    type: integer
                    example: null
                  name:
                    type: string
                    example: null
                example: null
          example: null
      example: null
    guestuserListResponseEntity:
      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
    guestuserResponse:
      type: object
      properties:
        GuestUser:
          $ref: '#/components/schemas/guestuserResponseEntity'
      example:
        GuestUser:
          sponsorUserName: Mr Spons
          guestAccessInfo:
            fromDate: 07/29/2014 14:44
            toDate: 10/29/2014 17:30
            location: San Jose
            validDays: 90
          customFields:
            another key: and its value
            some key: some value
          portalId: '23423432523'
          name: guestUser
          description: 'ERS Example user '
          id: dceff5c6-d4f2-48b7-92ae-87adcdd2777b
          guestInfo:
            emailAddress: email@some.uri.com
            password: asdlkj324ew
            phoneNumber: '+13211239034'
            smsServiceProvider: GLobal Default
            userName: DS3ewdsa34wWE
            enabled: true
          guestType: Contractor
    guestuserResponseEntity:
      properties:
        customFields:
          title: customFields
          type: object
          description: Key value map
          example: null
        guestType:
          title: guestType
          type: string
          description: ''
          example: null
        status:
          title: status
          type: string
          description: This field is applicable only for Get operation not applicable for Create and Update operations.
          example: null
        reasonForVisit:
          title: reasonForVisit
          type: string
          description: ''
          example: null
        personBeingVisited:
          title: personBeingVisited
          type: string
          description: ''
          example: null
        sponsorUserName:
          title: sponsorUserName
          type: string
          description: This field is applicable for Get and Create operations not applicable for Update operation.
          example: null
        sponsorUserId:
          title: sponsorUserId
          type: string
          description: This field is applicable only for Get operation not applicable for Create and Update operations.
          example: null
        statusReason:
          title: statusReason
          type: string
          description: ''
          example: null
        portalId:
          title: portalId
          type: string
          description: This field is applicable only for Create and Update operations not applicable for Get operation.<br/>Portal ID will be used to fetch configuration from Portal if missing from the Payload. For example Notification Language will be fetched from Portal if missing.
          example: null
        guestAccessInfo:
          properties:
            validDays:
              title: validDays
              type: object
              description: Number of days guest user is valid. To validate validDays property, ISE consider only date(not time) between fromDate and toDate properites.
              example: null
            fromDate:
              title: fromDate
              type: string
              description: ''
              example: null
            toDate:
              title: toDate
              type: string
              description: ''
              example: null
            location:
              title: location
              type: string
              description: ''
              example: null
            ssid:
              title: ssid
              type: string
              description: ''
              example: null
            groupTag:
              title: groupTag
              type: string
              description: ''
              example: null
          example: null
        guestInfo:
          properties:
            emailAddress:
              title: emailAddress
              type: string
              description: ''
              example: null
            enabled:
              title: enabled
              type: boolean
              description: This field is only for Get operation not applicable for Create, Update operations.
              example: null
            password:
              title: password
              type: string
              description: ''
              example: null
            phoneNumber:
              title: phoneNumber
              type: string
              description: Phone number should be E.164 format.
              example: null
            smsServiceProvider:
              title: smsServiceProvider
              type: string
              description: ''
              example: null
            userName:
              title: userName
              type: string
              description: This field is applicable for Get and Create operations not applicable for Update operation.<br/>If account needs be created with mobile number, please provide mobile number here
              example: null
            firstName:
              title: firstName
              type: string
              description: ''
              example: null
            lastName:
              title: lastName
              type: string
              description: ''
              example: null
            company:
              title: company
              type: string
              description: ''
              example: null
            creationTime:
              title: creationTime
              type: string
              description: ''
              example: null
            notificationLanguage:
              title: notificationLanguage
              type: string
              description: ''
              example: null
          example: null
        name:
          title: name
          type: string
          description: name
          example: null
        id:
          title: id
          type: string
          description: Id
          example: null
        description:
          title: description
          type: string
          description: Description
          example: null
        link:
          $ref: '#/components/schemas/Link'
      example: null
    guestuserListResponse:
      type: object
      properties:
        SearchResult:
          type: object
          properties:
            total:
              type: integer
              example: '2'
            resources:
              type: array
              example: null
              items:
                $ref: '#/components/schemas/guestuserListResponseEntity'
          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
    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