RTCIceServer.credentialType

The RTCIceServer dictionary's credentialType property is a string value which indicates what type of credential the RTCIceServer.credential value is. The default is password.

Syntax

var iceServer = {
                  ...
                  credentialType = newCredentialType,
                  ...
                };

var credentialType = iceServer.credentialType;

iceServer.credentialType = newCredentialType;

Value

The permitted values are:

oauth

The RTCIceServer requires the use of OAuth 2.0 to authenticate in order to use the ICE server described. This process is detailed in RFC 7635. This property was formerly called token.

password

The RTCIceServer requires a username and password to authenticate prior to using the described ICE server.

Example

This example creates a new RTCPeerConnection which will use a TURN server at turnserver.example.org to negotiate connections. Logging into the TURN server will use the username "webrtc" and the creative password "turnpassword". 

const myPeerConnection = new RTCPeerConnection({
  iceServers: [
    {
      urls: "turn:turnserver.example.org",  // A TURN server
      username: "webrtc",
      credential: "turnpassword",
      credentialType: "password"
    }
  ]
});

Specifications

Specification
WebRTC 1.0: Real-Time Communication Between Browsers
# dom-rtciceserver-credentialtype

Browser compatibility

BCD tables only load in the browser

See also