Microsoft Azure Turn API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Turn API
tags:
- name: Turn
paths:
  /networktraversal/:issueRelayConfiguration:
    post:
      tags:
      - Turn
      summary: Microsoft Azure Issue A Configuration For An Stun Turn Server For An Existing Identity
      operationId: microsoftAzureCommunicationnetworktraversalIssuerelayconfiguration
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationRelayConfiguration'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-examples:
        Issue Relay Configuration:
          $ref: ./examples/IssueRelayConfiguration.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommunicationRelayConfigurationRequest'
  /networkTraversal/:issueRelayConfiguration:
    post:
      tags:
      - Turn
      summary: Microsoft Azure Issue A Configuration For An Stun Turn Server
      operationId: microsoftAzureCommunicationnetworktraversalIssuerelayconfiguration
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter_2'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationRelayConfiguration_2'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-examples:
        Issue Relay Configuration:
          $ref: ./examples/IssueRelayConfiguration.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommunicationRelayConfigurationRequest_2'
        description: Optional request for providing the id and/or route type for the returned relay configuration.
components:
  schemas:
    CommunicationRelayConfiguration_2:
      description: A relay configuration containing the STUN/TURN URLs and credentials.
      required:
      - expiresOn
      - iceServers
      type: object
      properties:
        expiresOn:
          format: date-time
          description: The date for which the username and credentials are not longer valid. Will be 48 hours from request time.
          type: string
        iceServers:
          description: An array representing the credentials and the STUN/TURN server URLs for use in ICE negotiations.
          type: array
          items:
            $ref: '#/components/schemas/CommunicationIceServer_2'
    CommunicationRelayConfigurationRequest:
      description: Request for a CommunicationRelayConfiguration.
      type: object
      properties:
        id:
          description: An existing ACS identity.
          type: string
    CommunicationRelayConfigurationRequest_2:
      description: Request for a CommunicationRelayConfiguration.
      type: object
      properties:
        id:
          description: An identity to be associated with telemetry for data relayed using the returned credentials. Must be an existing ACS user identity. If not provided, the telemetry will not contain an associated identity value.
          type: string
        routeType:
          description: Filter the routing methodology returned. If not provided, will return all route types in separate ICE servers.
          $ref: '#/components/schemas/RouteType'
        ttl:
          type: integer
          format: int32
          description: The credential Time-To-Live (TTL), in seconds. The default value will be used if given value exceeds it.
          minimum: 0
          maximum: 172800
          default: 172800
    CommunicationIceServer:
      description: An instance of a STUN/TURN server with credentials to be used for ICE negotiation.
      required:
      - credential
      - urls
      - username
      type: object
      properties:
        urls:
          description: List of STUN/TURN server URLs.
          type: array
          items:
            type: string
        username:
          description: User account name which uniquely identifies the credentials.
          type: string
        credential:
          description: Credential for the server.
          type: string
    CommunicationIceServer_2:
      description: An instance of a STUN/TURN server with credentials to be used for ICE negotiation.
      required:
      - credential
      - urls
      - username
      - routeType
      type: object
      properties:
        urls:
          description: List of STUN/TURN server URLs.
          type: array
          items:
            type: string
        username:
          description: User account name which uniquely identifies the credentials.
          type: string
        credential:
          description: Credential for the server.
          type: string
        routeType:
          $ref: '#/components/schemas/RouteType'
    CommunicationRelayConfiguration:
      description: A relay configuration containing the STUN/TURN URLs and credentials.
      required:
      - expiresOn
      - iceServers
      type: object
      properties:
        expiresOn:
          format: date-time
          description: The date for which the username and credentials are not longer valid.
          type: string
        iceServers:
          description: An array representing the credentials and the STUN/TURN server URLs for use in ICE negotiations.
          type: array
          items:
            $ref: '#/components/schemas/CommunicationIceServer'
    RouteType:
      description: The routing methodology to where the ICE server will be located from the client. "any" will have higher reliability while "nearest" will have lower latency. It is recommended to default to use the "any" routing method unless there are specific scenarios which minimizing latency is critical.
      enum:
      - any
      - nearest
      type: string
      x-ms-enum:
        name: RouteType
        modelAsString: true
  parameters:
    ApiVersionParameter_2:
      in: query
      name: api-version
      description: Version of API to invoke.
      required: true
      schema:
        type: string
    ApiVersionParameter:
      in: query
      name: api-version
      description: Version of API to invoke.
      required: true
      schema:
        type: string
        enum:
        - 2021-06-21-preview
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'