IdentityCredential
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("FedCM API")}}{{SeeCompatTable}}{{SecureContext_Header}}
The **IdentityCredential** interface of the Federated Credential Management API (FedCM) represents a user identity credential arising from a successful federated sign-in.
A successful {{domxref("CredentialsContainer.get", "navigator.credentials.get()")}} call that includes an identity option fulfills with an IdentityCredential instance.
{{InheritanceDiagram}}
Instance properties
_Inherits properties from its ancestor, {{domxref("Credential")}}._
- {{domxref("IdentityCredential.configURL")}} {{ReadOnlyInline}} {{experimental_inline}}
- : A string specifying the config file URL of the {{glossary("Identity provider", "IdP")}} used for sign-in.
- {{domxref("IdentityCredential.isAutoSelected")}} {{ReadOnlyInline}} {{experimental_inline}}
- : A boolean value that indicates whether the federated sign-in was carried out using auto-reauthentication (i.e., without user mediation) or not.
- {{domxref("IdentityCredential.token")}} {{ReadOnlyInline}} {{experimental_inline}}
- : Returns the token used to validate the associated sign-in.
Static methods
- {{domxref("IdentityCredential.disconnect_static", "IdentityCredential.disconnect()")}} {{experimental_inline}}
- : Disconnects the federated sign-in account used to obtain the credential.
Examples
Basic federated sign-in
{{glossary("Relying party", "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: "********",
params: {/* IdP-specific parameters */},
},
],
},
});
}If successful, this call will fulfill with an IdentityCredential instance. From this, you could return the {{domxref("IdentityCredential.token")}} value, for example:
console.log(identityCredential.token);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
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- Federated Credential Management API