Key

A key is a type of authentication secret used for anonymous access to a Fauna database. Unlike tokens, keys are not associated with an identity.

`Key` collection

Fauna stores keys scoped to a database as documents in the database’s Key system collection.

Key documents have the following FQL structure:

{
  id: "371460335192768546",
  coll: Key,
  ts: Time("2099-07-28T02:23:51.300Z"),
  ttl: Time("2099-07-29T02:23:51.189192Z"),
  secret: "fn...",
  role: "admin"
}

Field name Value type Description

Field name	Value type	Description
`id`	Long	A unique identifier assigned by Fauna when the key is created.
`coll`	Collection	Collection name.
`ts`	Long	Creation timestamp, with microsecond resolution and time zone.
`ttl`	Time	Timestamp that defines the key expiration time. When the `ttl` time expires, the key is deleted. Default = `null`. The key persists indefinitely.
`secret`	String	The `secret` is a randomly generated cryptographic hash. This field isn’t stored in the document. The secret is only accessible in the `Key.create()` return. A caller obtains the secret from this return and stores it for subsequent queries. Fauna can’t recover a discarded or lost `secret`.
`role`	String	Name of a user-defined role or one of the built-in roles: `admin` `server` `server-readonly`
`data`	Object	User-defined metadata for the key.

id

Long

A unique identifier assigned by Fauna when the key is created.

coll

Collection

Collection name.

ts

Long

Creation timestamp, with microsecond resolution and time zone.

ttl

Time

Timestamp that defines the key expiration time. When the ttl time expires, the key is deleted.
Default = null. The key persists indefinitely.

secret

String

The secret is a randomly generated cryptographic hash. This field isn’t stored in the document. The secret is only accessible in the Key.create() return. A caller obtains the secret from this return and stores it for subsequent queries. Fauna can’t recover a discarded or lost secret.

role

String

Name of a user-defined role or one of the built-in roles:

admin
server
server-readonly

data

Object

User-defined metadata for the key.

Static methods

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

Method Description

Method	Description
`Key.all()`	Get the Set of all Key objects.
`Key.byId()`	Get a key by ID.
`Key.create()`	Create a key.
`Key.firstWhere()`	Get the first key matching a predicate function.
`Key.toString()`	Get the name of the Key collection as a string.
`Key.where()`	Get keys matching a predicate function.

Key.all()

Get the Set of all Key objects.

Key.byId()

Get a key by ID.

Key.create()

Create a key.

Key.firstWhere()

Get the first key matching a predicate function.

Key.toString()

Get the name of the Key collection as a string.

Key.where()

Get keys matching a predicate function.