Keys are linked to a database, allowing access to database contents.

A Key document has no associated credential, so there is no identity. The lack of a credential means that keys grant anonymous access to a database. Any user or process with a Fauna key secret can access the database associated with the key.

A key has a defined Role that determines the access level of operations associated with the key.

Document definition

Static methods

Method Description

Get the set of all Key objects.

Get a key by ID.

Create a key.

Get the first key matching a predicate function.

Get the name of the Key collection as a string.

Get keys matching a predicate function.

Instance methods

Method Description

Delete a key.

Verify a key.

Replace a key.

Update a key.

Is this article helpful? 

Tell Fauna how the article can be improved:
Visit Fauna's forums or email

Thank you for your feedback!