openapi: 3.0.0
info:
  description: Aura authentication API definition.
  version: 10.25.0
  title: Aura authentication API Swagger
  contact:
    email: auradev@tid.es
tags:
  - name: Users administration
    description:
      Services to administrate users in Aura. Only admin users can access these
      endpoints.
  - name: Aura users
    description: Services to handle users in Aura
  - name: Directline token
    description: Services to generate valid directline tokens and conversations
  - name: OpenId configuration
    description: Services to obtain Aura OpenId configuration
  - name: Monitoring
    description: Endpoint to monitor authentication-api server
paths:
  /aura-services/v1/users/aura-id:
    get:
      tags:
        - Aura users
      summary:
        Gets given user data to register her in aura systems. If user already
        exists, it will be returned with the same values, otherwise it will be
        created and then returned.
      description: Register a new user belonging to a non integrated channel
      operationId: getUserByTokenInfo
      security:
        - apiKeyHeader: []
      parameters:
        - name: x-4p-channel-id
          in: header
          description: Channel id that defines the origin of the user request
          required: false
          schema:
            type: string
        - name: x-token-info
          in: header
          description:
            User authentication data. It might contain JWT object, plain or
            encoded (to keep backwards compatibility).
          required: true
          schema:
            type: string
        - name: x-token-info-encoded
          in: header
          description: Indicates whether or not x-token-info is encoded.
          required: false
          schema:
            type: string
          deprecated: true
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: Successfully retrieved
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuraUserResponse"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "409":
          $ref: "#/components/responses/Conflict"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
    delete:
      operationId: notDeleteAuraId
      responses:
        "405":
          $ref: "#/components/responses/MethodNotAllowed"
      x-swagger-router-controller: "modules"
  /aura-services/v1/users/aura-id/{auraId}:
    get:
      tags:
        - Aura users
      summary:
        Gets given user data to register her in aura systems. If user already
        exists, it will be returned with the same values, otherwise it will be
        created and then returned.
      description: Register a new user belonging to a non integrated channel
      operationId: getUserByTokenInfoAndAuraId
      security:
        - apiKeyHeader: []
      parameters:
        - name: auraId
          in: path
          description: Unique Aura user identifier to look for
          required: true
          schema:
            type: string
        - name: x-4p-channel-id
          in: header
          description: Channel id that defines the origin of the user request
          required: true
          schema:
            type: string
        - name: x-token-info
          in: header
          description:
            User authentication data. It might contain JWT object, plain or
            encoded (to keep backwards compatibility).
          required: true
          schema:
            type: string
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: Successfully retrieved
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuraUserResponse"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "409":
          $ref: "#/components/responses/Conflict"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/users/auraid/integrated:
    get:
      deprecated: false
      tags:
        - Aura users
      summary:
        Gets given authorization and identification information to register the
        user.
      description: Registers users belonging to integrated channels
      operationId: getIntegratedAuraIdUser
      parameters:
        - name: state
          in: query
          description: Internal signed validation code sent by aura-bot
          required: true
          schema:
            type: string
            format: uuid
        - name: code
          in: query
          description: Unique code generated to validate the sign-up request
          required: false
          schema:
            type: string
        - name: error
          in: query
          description: Code of the error that happened in the authenticator
          required: false
          schema:
            type: string
        - name: error_description
          in: query
          description: Description of the error that happened in the authenticator
          required: false
          schema:
            type: string
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: Successfully retrieved
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
        "302":
          description: Successfully retrieved, call to channel endpoint
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
        "400":
          description: Incoming HTTP request format is not valid
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            text/html:
              schema:
                $ref: "#/components/schemas/AuraError"
        "401":
          description: Incoming HTTP request authorization is not valid
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            text/html:
              schema:
                $ref: "#/components/schemas/AuraError"
        "409":
          description:
            The request could not be completed due to a conflict with the current
            state of the target resource.
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            text/html:
              schema:
                $ref: "#/components/schemas/AuraError"
        "500":
          description: Unexpected internal error
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            text/html:
              schema:
                $ref: "#/components/schemas/AuraError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/users/auraid/integrated/logout:
    get:
      deprecated: false
      tags:
        - Aura users
      summary: This is the standard OpenID logout procedure. Removes an access session from 4P.
      description:
        Remove a 4th Platform access session when it is not going to be used any
        longer.
      operationId: getLogoutIntegratedAuraTokenHint
      parameters:
        - name: state
          in: query
          description: State
          required: true
          schema:
            type: string
            format: uuid
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: Successfully retrieved
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
        "302":
          description: Successfully retrieved, call to channel endpoint
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
        "400":
          description: Incoming HTTP request format is not valid
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            text/html:
              schema:
                $ref: "#/components/schemas/AuraError"
        "401":
          description: Incoming HTTP request authorization is not valid
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            text/html:
              schema:
                $ref: "#/components/schemas/AuraError"
        "409":
          description:
            The request could not be completed due to a conflict with the current
            state of the target resource.
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            text/html:
              schema:
                $ref: "#/components/schemas/AuraError"
        "500":
          description: Unexpected internal error
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            text/html:
              schema:
                $ref: "#/components/schemas/AuraError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/users/{auraId}:
    get:
      deprecated: false
      tags:
        - Aura users
      summary: Retrieves Aura user by her auraId.
      description: Retrieves an Aura User
      operationId: getUserByAuraId
      security:
        - apiKeyHeader: []
      parameters:
        - name: correlator
          in: header
          description:
            Unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: x-correlator
          in: header
          description:
            Unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: auraId
          in: path
          description: Unique Aura user identifier to look for
          required: true
          schema:
            type: string
            format: uuid
        - name: return-anonymous
          in: header
          description:
            Boolean flag to indicate if you want to return an anonymous user as response
          required: false
          schema:
            type: string
        - name: x-4p-channel-id
          in: header
          description:
            unique identifier of a request to be used as correlator in all systems
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Successfully retrieved
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuraUser"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          $ref: "#/components/responses/Conflict"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
    delete:
      tags:
        - Aura users
      summary: Removes information related to given auraId
      description: Removes information related to given auraId
      operationId: deleteUserByAuraId
      security:
        - apiKeyHeader: []
      parameters:
        - name: x-4p-channel-id
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: x-correlator
          in: header
          description:
            Unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: x-token-info
          in: header
          description:
            User authentication data. It might contain JWT object, plain or
            encoded (to keep backwards compatibility).
          required: true
          schema:
            type: string
        - name: auraId
          in: path
          description: Unique Aura user identifier to look for
          required: true
          schema:
            type: string
      responses:
        "204":
          description: Successfully removed
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "409":
          $ref: "#/components/responses/Conflict"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/users/aura-id-global/{aura_id_global}:
    get:
      tags:
        - Aura users
      summary: Retrieves an aura user by the given auraIdGlobal and the channelId
      description: Register a new user belonging to a non integrated channel
      operationId: getAuraUserByAuraIdGlobalAndChannelId
      security:
        - apiKeyHeader: []
      parameters:
        - name: aura_id_global
          in: path
          description: Aura user identifier valid for all channels
          required: true
          schema:
            type: string
        - name: x-4p-channel-id
          in: header
          description: Channel id that defines the origin of the user request
          required: false
          schema:
            type: string
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: x-token-info
          in: header
          description:
            User authentication data. It might contain JWT object, plain or
            encoded (to keep backwards compatibility).
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Successfully retrieved
          headers:
            correlator:
              description: Correlation id for the different services
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FullAuraUserResponse"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          $ref: "#/components/responses/Conflict"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/token:
    options:
      tags:
        - Directline token
      summary: Allow calling directline token from browsers
      operationId: getDirectlineTokenOptions
      responses:
        default:
          description: CORS headers for all operations
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
                default: "*"
      x-swagger-router-controller: "modules"
    get:
      tags:
        - Directline token
      summary: Calls directline servers to get a brand new token to start a new
        conversation with Aura Bot
      description: Gets a new direct line token to start a conversation with AuraBot
      operationId: getDirectlineToken
      security:
        - apiKeyHeader: []
      parameters:
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: Successfully retrieved
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DirectlineToken"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/token/wss:
    options:
      tags:
        - Directline token
      summary: Allow calling directline token from browsers
      operationId: getDirectlineTokenOptionsWss
      responses:
        default:
          description: CORS headers for all operations
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
                default: "*"
      x-swagger-router-controller: "modules"
    get:
      tags:
        - Directline token
      summary: Calls directline servers to get a brand new token to start a new
        conversation with Aura Bot
      description: Gets a new direct line token to start a conversation with AuraBot
      operationId: getDirectlineTokenWss
      security:
        - apiKeyHeader: []
      parameters:
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: Successfully retrieved
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DirectlineTokenWss"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/openid/issuer/.well-known/openid-configuration:
    get:
      tags:
        - OpenId configuration
      summary: Returns object with the jwt uri
      description: Returns object with the jwt uri
      operationId: getJwkUrl
      parameters:
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: Successfully retrieved
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/JwkUrl"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/openid/jwk:
    get:
      tags:
        - OpenId configuration
      summary: Returns object containing the publickey for aura environment
      description: Returns object containing the publickey for aura environment
      operationId: getPublicKey
      parameters:
        - name: correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
        - name: x-correlator
          in: header
          description:
            unique identifier of a request to be used as correlator in all
            systems
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: Successfully retrieved
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Jwk"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/ping:
    get:
      tags:
        - Monitoring
      summary: Healthcheck endpoint to validate if the server is up and running
      description: Healthcheck enpoint to validate if the server is up and running
      operationId: ping
      security:
        - apiKeyHeader: []
      responses:
        "200":
          description: Successful
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuraError"
      x-swagger-router-controller: "modules"
  /aura-services/v1/config:
    get:
      tags:
        - "Configuration administration"
      summary: "Provides information about aura configuration needed by 3rd parties."
      description: "Returns a JSON object with public configuration settings."
      operationId: getPublicConfiguration
      security:
        - apiKeyHeader: []
      parameters:
        - name: "correlator"
          in: "header"
          description: "Unique identifier of a request to be used as correlator in all systems"
          required: false
          schema:
            type: string
            format: uuid
        - name: "x-correlator"
          in: "header"
          description: "Unique identifier of a request to be used as correlator in all systems"
          required: false
          schema:
            type: string
            format: uuid
      responses:
        200:
          description: "Successfully retrieved"
          headers:
            correlator:
              description: "Correlation id for the different services"
              schema:
                type: "string"
            x-correlator:
              description: "Correlation id for the different services"
              schema:
                type: "string"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ConfigurationResponse"
        401:
          $ref: "#/components/responses/Unauthorized"
        500:
          $ref: "#/components/responses/InternalError"
      x-swagger-router-controller: "modules"
  /healthz:
    get:
      tags:
        - Monitoring
      summary:
        Healthcheck endpoint to validate if the server is up and running, only
        available from local network
      description:
        Healthcheck enpoint to validate if the server is up and running, only
        available from local network
      operationId: healthz
      responses:
        "200":
          description: Successful
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuraError"
      x-swagger-router-controller: "modules"
  /heapStatistics:
    get:
      tags:
        - monitoring
      description: heap usage statistics.
      operationId: heapStatistics
      x-swagger-router-controller: "modules"
      responses:
        "200":
          description: Heap statistics
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HeapStatisticsResponse"
        "500":
          description: Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuraError"
  /heapSnapshots:
    get:
      tags:
        - monitoring
      description: Generate heap snapshot.
      operationId: heapSnapshots
      x-swagger-router-controller: "modules"
      responses:
        "200":
          description: Heap snapshots generated
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HeapSnapshotsResponse"
        "500":
          description: Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuraError"
        "503":
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuraError"

servers:
  - url: https://localhost:3000
components:
  responses:
    InvalidRequest:
      description: Incoming HTTP request format is not valid
      headers:
        correlator:
          description: Correlation id for the different services
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuraError"
    Unauthorized:
      description: Incoming HTTP request authorization is not valid
      headers:
        correlator:
          description: Correlation id for the different services
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuraError"
    Conflict:
      description:
        The request could not be completed due to a conflict with the current
        state of the target resource.
      headers:
        correlator:
          description: Correlation id for the different services
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuraError"
    TooManyRequests:
      description: The user has sent too many requests in a given amount of time
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuraError"
    InternalError:
      description: Unexpected internal error
      headers:
        correlator:
          description: Correlation id for the different services
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuraError"
    NotFound:
      description: Request resource not found
      headers:
        correlator:
          description: Correlation id for the different services
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuraError"
    MethodNotAllowed:
      description: Request method not allowed
      headers:
        correlator:
          description: Correlation id for the different services
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuraError"
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    apiKeyHeader:
      type: apiKey
      name: Authorization
      in: header
  schemas:
    ConfigurationResponse:
      type: object
      properties:
        domain:
          type: string
          description: name of the Azure storage subdomain
      description: Public and secure settings
      example:
        domain: auraapcurrent66666a8f
    AuraUserResponse:
      type: object
      required:
        - channel_id
        - aura_id
        - user_id
        - phone_number
      properties:
        channel_id:
          type: string
          format: uuid
          description: unique id of the channel in aura systems
        aura_id:
          type: string
          description: Auraid generated
        user_id:
          type: string
          description: identifier of the user in the OB
        phone_number:
          type: string
          description:
            user phone number in international format. Empty if not included in
            authentication context.
      description: Aura external user
    FullAuraUserResponse:
      type: object
      required:
        - aura_id_global
      allOf:
        - $ref: "#/components/schemas/AuraUserResponse"
        - properties:
            aura_id_global:
              type: string
              description: hashed id based on userId and authentification param
      description: Aura external full user
    AuraUser:
      type: object
      required:
        - auraIdGlobal
        - auraId
        - userId
        - phoneNumber
        - authorizationId
        - channelId
        - idTokenHint
      properties:
        auraIdGlobal:
          type: string
          description: hashed id based on userId and authentification params
        auraId:
          type: string
          description: unique id for the user in Aura systems
        userId:
          type: string
          description: unique id for the user in the OB systems
        phoneNumber:
          type: string
          description:
            user phone number in international format. if its registered, if
            not, it will be an empty string
        authorizationId:
          type: string
          description:
            user authorizationId in 4P. Depending on the channel authencation
            process it can be empty.
        channelId:
          type: string
          format: uuid
          description: unique id of the channel in aura systems
        idTokenHint:
          type: string
          nullable: true
          description: in the case of integrated authentication based in callback, it contains the identifier to handle the user authentication session in 4P.
        expiresAt:
          type: string
          description: time when the authorizationId will be expired by deleting the user from the database. In ISO 8601 format
      description: Aura user
    DirectlineToken:
      type: object
      description: token object returned by direct line
      properties:
        token:
          type: string
          description: Directline token
        expires_in:
          type: number
          description: Seconds to expire since token was created.
      example:
        expires_in: 3600
        token: AXCifkJX...EVecsRNSXnFw
    DirectlineTokenWss:
      allOf:
        - $ref: "#/components/schemas/DirectlineToken"
        - type: object
        - description: token object returned by direct line
        - properties:
            conversationId:
              type: string
              description: Conversation identifier valid for the current bot.
            streamUrl:
              type: string
              description: Uri for Secure Websocket
            referenceGrammarId:
              type: string
              description: ID for the reference grammar for this bot conversation.
        - example:
            conversationId: CrnUPgOOYrt5CjdJ1kBOPb-h
            expires_in: 3600
            token: token
            streamUrl: wss://directline.botframework.com/v3/directline/conversations/AXCifkJX...EVecsRNSXnFw
            referenceGrammarId: 4fcf85f0-4838-b45f-8290-6619774f88a8
    JwkUrl:
      type: object
      description: object containing the jwk url
      properties:
        jwks_uri:
          type: string
    Jwk:
      type: object
      description: object containint the jwk
      properties:
        keys:
          type: array
          items:
            type: object
    AuraError:
      type: object
      description: Error response
      properties:
        code:
          type: string
          description: Unique id of the error
        message:
          type: string
          description: Specific and descriptive text of the error
    HeapStatisticsResponse:
      type: object
      properties:
        total_heap_size:
          type: number
          description: Total heap size
        total_heap_size_executable:
          type: number
          description: Total heap size executable
        total_physical_size:
          type: number
          description: Total physical size
        total_available_size:
          type: number
          description: Total available size
        used_heap_size:
          type: number
          description: Used heap size
        heap_size_limit:
          type: number
          description: Heap size limit
        malloced_memory:
          type: number
          description: Malloced memory
        peak_malloced_memory:
          type: number
          description: Peak malloced memory
        does_zap_garbage:
          type: number
          description: Does zap garbage
        number_of_native_contexts:
          type: number
          description: Number of native contexts
        number_of_detached_contexts:
          type: number
          description: Number of detached contexts
    HeapSnapshotsResponse:
      type: object
      properties:
        status:
          type: string
          description: Snapshots creations and upload status
        description:
          type: string
          description: Status description

