Key.byId()

Learn: Keys

Get a key by its document id.

Signature

Key.byId(id: ID) => Ref<Key>

Description

Gets a key, represented as an Key document, by its document id.

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.

Parameters

Parameter Type Required Description

id

String

true

ID of the Key document to retrieve.

Return value

Type Description

Ref<Key>

Resolved reference to the Key document. Can resolve to an existing document or a NullDoc.

Examples

Key.byId("412655134325080576")
{
  id: "412655134325080576",
  coll: Key,
  ts: Time("2099-08-01T02:45:50.490Z"),
  role: "admin",
  data: {
    desc: "Admin key for prod app database"
  }
}
\