Check out v4 of the Fauna CLI

v4 of the Fauna CLI is now in beta.

The new version introduces enhancements to the developer experience, including an improved authentication workflow. To get started, check out the CLI v4 quick start.

`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

Parameter	Type	Required	Description
id	String	true	ID of the `Key` document to retrieve.

String

true

ID of the Key document to retrieve.

Return value

Type Description

Type	Description
Ref<Key>	Resolved reference to the `Key` document. Can resolve to an existing document or a NullDoc.

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"
  }
}

Is this article helpful?

Tell Fauna how the article can be improved:
Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!