Partager via

2.2.3.1.3.2 credentialsResponseType Type Definition

  • Article

The schema definition for credentialsResponseType type is as follows:

 <!--CREDENTIALS RESPONSE TYPE-->
   <xs:complexType name="credentialsResponseType">
     <xs:sequence>
       <xs:element name="credentials" type="tns:credentialsType" />
       <xs:element name="mediaRelayList" type="tns:mediaRelayListType" />
     </xs:sequence>
     <xs:attribute name="credentialsRequestID" type="tns:max64CharStringType" use="required" />
   </xs:complexType>

The following table describes the credentialsResponseType type's elements.

Element

Description

credentials

The type of this element is credentialsType, as defined in section 2.2.4.3. This element MUST contain the following subelements:

  • A username element and a password element, which form the security token needed by the protocol client to contact the TURN server.

  • A duration element that specifies how long the token is valid for.

This element SHOULD contain an optional realm element that specifies which network segment the server belongs to. The network segment information is configured on the server and is implementation specific.

mediaRelayList

The type of this element is mediaRelayListType, as defined in section 2.2.4.5. Each mediaRelay element in mediaRelayList MUST contain the following subelements:

  • A location element that indicates "internet" or "intranet".

  • Either the hostName element or the directIPAddress element. If hostName is present, it SHOULD contain the IP address of the TURN server or the FQDN that resolves to the TURN server’s IP address. If directIPAddress is present, it MUST contain the IP4 or IPv6<4> address of the TURN server.

Each mediaRelay element in mediaRelayList SHOULD contain the following subelements:

  • An optional tcpPort element that specifies the port the TURN server is using to listen for TCP.

  • An optional udpPort element that specifies the port the TURN server is using to listen for UDP.

The following table describes the credentialsResponseType type's attribute.

Attribute

Description

credentialsRequestID

This MUST be the same as the credentialsRequestID attribute in the request.