Check out v4 of the Fauna CLI

v4 of the Fauna CLI is now in beta.

The new version introduces enhancements to the developer experience, including an improved authentication workflow. To get started, check out the CLI v4 quick start.

Credential

Learn: Credentials

A credential associates a password with an identity document. You can use the credential and password to create an authentication token for an end user, system, or other identity.

Credential collection

Fauna stores credentials as documents in the Credential system collection. You can also access this collection using the Credentials alias.

Credential documents have the following FQL structure:

{
  id: "401328088768577609",
  coll: Credential,
  ts: Time("2099-06-21T18:39:00.735Z"),
  document: Customer("401328088729780297")
}
Field name Type Description

id

ID

Immutable identifier for the document. Unique within the collection. For the Credential collection, the ID is auto-generated.

coll

Collection

Credential

ts

Time

Last time the document was updated.

document

Ref<{ *: Any }>

Reference to the credential’s identity document. The identity document can be in any user-defined collection.

Static methods

You can use the following static methods to manage the Credential collection in FQL.

Method Description

Credential.all()

Get all the identities.

Credential.byDocument()

Get a document credential.

Credential.byId()

Get a credential by its ID.

Credential.create()

Create a credential.

Credential.firstWhere()

Get the first credential matching a predicate function.

Credential.toString()

Get the name of the Credential collection as a string.

Credential.where()

Get identities matching a predicate function.

Instance methods

You can use the following instance methods to manage specific Credential documents in FQL.

Method Description

credential.delete()

Delete a credential.

credential.exists()

Test a credential exists.

credential.login()

Log in to Fauna.

credential.replace()

Replace a credential.

credential.update()

Update a credential.

credential.verify()

Password verification.

Is this article helpful? 

Tell Fauna how the article can be improved:
 Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!