Web/API/RTCIceServer/credentialType

The RTCIceServer dictionary's credentialType property is a string value from the RTCIceCredentialType enum 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 found in the RTCIceCredentialType enumerated string type:

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".

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

Specifications

Specification	Status	Comment
WebRTC 1.0: Real-time Communication Between BrowsersThe definition of 'RTCIceServer.credential' in that specification.	Candidate Recommendation	Initial specification.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`credentialType`	Chrome Full support Yes	Edge Full support ≤79	Firefox Full support 47	IE No support No	Opera ?	Safari ?	WebView Android No support No	Chrome Android Full support Yes	Firefox Android Full support 47	Opera Android ?	Safari iOS ?	Samsung Internet Android Full support Yes

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown