Web/API/RTCIceServer/credential

Draft This page is not complete.

I'm experimenting with structure for pages documenting members of dictionaries. Please contact sheppy with any feedback.

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The RTCIceServer dictionary's credential property is a string providing the credential to use when connecting to the described server. This is typically a password, key, or other secret.

This value is used when the RTCIceServer describes a TURN server.

Syntax

var iceServer = {
                  ...
                  credential = credential,
                  ...
                };

var credential = iceServer.credential;

iceServer.credential = newCredential;

Example

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

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

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
`credential`	Chrome Full support Yes	Edge Full support ≤79	Firefox Full support 22	IE No support No	Opera ?	Safari ?	WebView Android No support No	Chrome Android Full support Yes	Firefox Android Full support 24	Opera Android ?	Safari iOS ?	Samsung Internet Android Full support Yes

Legend

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