FederatedCredentialInit
TheFederatedCredentialInit dictionary represents the object passed toCredentialsContainer.create() as the value of thefederated option: that is, when creating aFederatedCredential object representing a credential associated with a federated identify provider.
Note:TheFederated Credential Management API (FedCM) supersedes theFederatedCredential interface in favor of theIdentityCredential interface.
TheFederatedCredentialInit dictionary is not used when working with theIdentityCredential interface.
In this article
Instance properties
iconURLOptionalA string representing the URL of an icon or avatar to be associated with the credential.
idA string representing a unique ID for the credential.
nameOptionalA string representing the credential username.
originA string representing the credential's origin.
FederatedCredentialobjects are origin-bound, which means that they will only be usable on the specified origin they were intended to be used on.protocolOptionalA string representing the protocol of the credentials' federated identity provider (for example,
"openidconnect").providerA string representing the credentials' federated identity provider (for example
"https://www.facebook.com"or"https://accounts.google.com").
Examples
>Creating a federated identity credential
const credInit = { id: "1234", name: "Serpentina", origin: "https://example.org", protocol: "openidconnect", provider: "https://provider.example.org",};const makeCredential = document.querySelector("#make-credential");makeCredential.addEventListener("click", async () => { const cred = await navigator.credentials.create({ federated: credInit, }); console.log(cred.name); console.log(cred.provider);});Specifications
| Specification |
|---|
| Credential Management Level 1> # dom-federatedcredential-federatedcredential> |