RTCPeerConnection: idpLoginUrl property
The idpLoginUrl read-only property of the RTCPeerConnection interface returns a string containing the URL endpoint the application can open to log users in to the identity provider (IdP). This value is null until the IdP indicates that login is needed.
When a call to RTCPeerConnection.getIdentityAssertion() fails because the IdP requires user authentication, the resulting promise is rejected with an RTCError whose errorDetail is "idp-need-login". The browser then sets this property to the login URL provided by the IdP. The application can open this URL (for example, in a pop-up window or <iframe>) to allow the user to complete the login process before retrying the identity assertion.
Value
A string containing the IdP login URL, or null if no login is needed.
Examples
Handling an IdP login requirement
In this example, the application attempts to gather an identity assertion. If the IdP rejects the attempt because the user is not authenticated, the application opens the login URL provided in idpLoginUrl.
const pc = new RTCPeerConnection();
pc.setIdentityProvider("login.example.com");
pc.getIdentityAssertion().catch((error) => {
if (pc.idpLoginUrl) {
console.log(`IdP login required at: ${pc.idpLoginUrl}`);
// Open the login page in a popup window
const loginWindow = window.open(
pc.idpLoginUrl,
"idp-login",
"width=500,height=600",
);
} else {
console.error("Identity assertion failed:", error);
}
});
Specifications
| Specification |
|---|
| Identity for WebRTC 1.0 # dom-rtcpeerconnection-idploginurl |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
idpLoginUrl
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support