IdentityCredential
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The IdentityCredential
interface of the Federated Credential Management API (FedCM) represents a user identity credential arising from a successful federated sign-in.
Instance properties
Inherits properties from its ancestor, Credential
.
IdentityCredential.token
Experimental-
Returns a
Promise
that resolves with theCredential
instance that matches the provided parameters.
Examples
Relying parties (RPs) can call navigator.credentials.get()
with the identity
option to make a request for users to sign in to the RP via an identity provider (IdP), using identity federation. A typical request would look like this:
async function signIn() {
const identityCredential = await navigator.credentials.get({
identity: {
providers: [
{
configURL: "https://accounts.idp.example/config.json",
clientId: "********",
nonce: "******",
},
],
},
});
}
A successful navigator.credentials.get()
call that includes an identity
option fulfills with an IdentityCredential
instance.
Check out Federated Credential Management API (FedCM) for more details on how this works. This call will start off the sign-in flow described in FedCM sign-in flow.
Specifications
Specification |
---|
Federated Credential Management API # browser-api-identity-credential-interface |
Browser compatibility
BCD tables only load in the browser