web api static method

IdentityProvider: close() static method

Secure contextLimited availability

The close() static method of the IdentityProvider interface provides a manual signal to the browser that an IdP sign-in flow is finished.

close() needs to be called from the same origin as the specified IdP’s sign-in dialog, as defined in the IdP config.

close() is used to close the IdP sign-in dialog when sign-in is completely finished and the IdP has finished collecting data from the user. A primary use case for close() is closing the IdP sign-in dialog in cases where the browser and the IdP login status become out of sync, and the browser initiates a dynamic sign-in flow to correct the issue.

Syntax

IdentityProvider.close()

Parameters

None.

Return value

undefined.

Examples

Basic `IdentityProvider.close()` usage

IdentityProvider.close();

Specifications

SpecificationsStandards references are available on the canonical MDN page.

Browser compatibility

Browser compatibilityCompatibility data is available on the canonical MDN page.