Credential

Description

The Credential collection is a native collection of credential documents. A credential combines a document id and a password typically to uniquely identify a person, but credentials may also identify a service, system, or process that needs to run privileged queries in Fauna.

Except for documents in server native collections, any Fauna document can have a credential in this collection.

Fauna uses Credential to authenticate identities needing access to database resources. A successful Credential.login() method creates a corresponding Token document. Tokens work with roles to authorize resource access. Role documents control identity authorization by configuring the membership and privileges associated with database resources.

See the Credential document definition

Static methods

Method Description

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.where()`	Get identities matching a predicate function.

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.where()

Get identities matching a predicate function.

Instance methods

Method Description

Method	Description
`delete()`	Delete a credential.
`exists()`	Test a credential exists.
`login()`	Log in to Fauna.
`replace()`	Replace a credential.
`update()`	Update a credential.
`verify()`	Password verification.

delete()

Delete a credential.

exists()

Test a credential exists.

login()

replace()

Replace a credential.

update()

Update a credential.

verify()

Password verification.

Is this article helpful?