View as markdown
Copy for LLM Open in ChatGPT Open in Claude Open in Perplexity

FedCm

Experimental

This domain allows interacting with the FedCM dialog.

Commands

FedCm.enable

Parameters
Name Type Description
disableRejectionDelay (optional) boolean Allows callers to disable the promise rejection delay that would
normally happen, if this is unimportant to what's being tested.
(step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)

FedCm.disable

FedCm.selectAccount

Parameters
Name Type Description
dialogId string
accountIndex integer

FedCm.clickDialogButton

Parameters
Name Type Description
dialogId string
dialogButton DialogButton

FedCm.openUrl

Parameters
Name Type Description
dialogId string
accountIndex integer
accountUrlType AccountUrlType

FedCm.dismissDialog

Parameters
Name Type Description
dialogId string
triggerCooldown (optional) boolean

FedCm.resetCooldown

Resets the cooldown time, if any, to allow the next FedCM call to show
a dialog even if one was recently dismissed by the user.

Events

FedCm.dialogShown

Parameters
Name Type Description
dialogId string
dialogType DialogType
accounts array<Account>
title string These exist primarily so that the caller can verify the
RP context was used appropriately.
subtitle (optional) string

FedCm.dialogClosed

Triggered when a dialog is closed, either by user action, JS abort,
or a command below.

Parameters
Name Type Description
dialogId string

Types

LoginState

(string)

Whether this is a sign-up or sign-in action for this account, i.e.
whether this account has ever been used to sign in to this RP before.

Allowed Values
  • SignIn
  • SignUp

DialogType

(string)

The types of FedCM dialogs.

Allowed Values
  • AccountChooser
  • AutoReauthn
  • ConfirmIdpLogin
  • Error

DialogButton

(string)

The buttons on the FedCM dialog.

Allowed Values
  • ConfirmIdpLoginContinue
  • ErrorGotIt
  • ErrorMoreDetails

AccountUrlType

(string)

The URLs that each account has

Allowed Values
  • TermsOfService
  • PrivacyPolicy

Account

(object)

Corresponds to IdentityRequestAccount

Properties
Name Type Description
accountId string
email string
name string
givenName string
pictureUrl string
idpConfigUrl string
idpLoginUrl string
loginState LoginState
termsOfServiceUrl (optional) string These two are only set if the loginState is signUp
privacyPolicyUrl (optional) string

Summary