Token.byDocument()

Learn: Tokens

Get a token by its identity document.

Signature

Token.byDocument(document: { *: Any }) => Set<Token>

Description

Gets a token, represented as a Token document, by its identity document. An identity document can have multiple tokens.

A token is a type of authentication secret used to provide identity-based access to a Fauna database. Fauna stores tokens as documents in the Token system collection.

Parameters

Parameter Type Required Description

document

Object

true

Identity document for the token to retrieve.

Return value

Type Description

Set<Token>

Resolved reference to a Token document.

Examples

Token.byDocument(Customer.byId("111"))
{
  data: [
    {
      id: "371233004820889634",
      coll: Token,
      ts: Time("2099-07-25T14:10:32.165Z"),
      document: Customer("111")
    },
    ...
  ]
}
\