Credential

Description

A credential combines a document id and a password to uniquely identify a person, service, system, or process that needs to run privileged queries.

Credentials are used to authenticate identities that need access to database resources. The login() and Token.create() methods create a Token document that works with Roles to authorize resource access. Role documents control identity-based authorization by configuring the membership and privileges associated with database resources.

Except for documents in server native collections, any document can have an associated credential.

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.toString()`	Get the name of the Credential collection as a string.
`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.toString()

Get the name of the Credential collection as a string.

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?