Web/API/PasswordCredential

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The interface of the Credential Management API provides information about a username/password pair. In supporting browsers an instance of this class may be passed in the credential member of the init object for global fetch.

Note: This interface is restricted to top-level contexts and cannot be used from an <iframe>.

Constructor

PasswordCredential()Secure context

Creates a new PasswordCredential object.

Properties

Inherits properties from its ancestor, Credential.

PasswordCredential.additionalData  ' Secure context

One of a FormData instance, a URLSearchParams instance, or null. The data in the objects will be added to the request body and sent to the remote endpoint with the credentials.

PasswordCredential.iconURL Read only Secure context

A USVString containing a URL pointing to an image for an icon. This image is intended for display in a credential chooser. The URL must be accessible without authentication.

PasswordCredential.idName  ' Secure context

A USVString containing the name that will be used for the ID field when submitting the current object to a remote endpoint via fetch. This property defaults to 'username', but may be overridden to match whatever the backend service expects.

PasswordCredential.name Read only Secure context

A USVString containing a human-readable public name for display in a credential chooser.

PasswordCredential.password Read only Secure context

A USVString containing the password of the credential.

PasswordCredential.passwordName  ' Secure context

A USVString representing the name that will be used for the password field when submitting the current object to a remote endpoint via fetch. This property defaults to 'password', but may be overridden to match whatever the backend service expects.

Event handlers

None.

Methods

None.

Examples

var cred = new PasswordCredential({
  id: id,
  password: password,
  name: name,
  iconURL: iconUrl
});

navigator.credentials.store(cred)
 .then(function() {
 // Do something else.
});

Specifications

Specification	Status	Comment
Credential Management Level 1	Working Draft	Initial definition.

Browser Compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
PasswordCredential Experimental'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0
PasswordCredential() constructor Non-standard'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0
additionalData Experimental'Deprecated'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0
iconURL Experimental'	Chrome Full support 52	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 39	Safari ?	WebView Android Full support 52	Chrome Android Full support 52	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 6.0
idName Experimental'Deprecated'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0
name Experimental'	Chrome Full support 52	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 39	Safari ?	WebView Android Full support 52	Chrome Android Full support 52	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 6.0
password Experimental'	Chrome Full support 60	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 47	Safari ?	WebView Android Full support 60	Chrome Android Full support 60	Firefox Android ?	Opera Android Full support 44	Safari iOS ?	Samsung Internet Android Full support 8.0
passwordName Experimental'Deprecated'	Chrome Full support 51	Edge Full support ≤79	Firefox ?	IE No support No	Opera Full support 38	Safari ?	WebView Android Full support 51	Chrome Android Full support 51	Firefox Android ?	Opera Android Full support 41	Safari iOS ?	Samsung Internet Android Full support 5.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

Non-standard. Expect poor cross-browser support.'

Non-standard. Expect poor cross-browser support.

Deprecated. Not for use in new websites.'

Deprecated. Not for use in new websites.

PasswordCredential by Mozilla Contributors is licensed under CC-BY-SA 2.5.