Credential.byId()

Learn: Credentials

Get a credential by its document id.

Signature

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

Description

Gets a credential, represented as an Credential document, by its document id.

A credential associates a password with an identity document. You can use credentials and the credential.login() method to create tokens as part of an end-user authentication system.

Parameters

Parameter Type Required Description

id

String

true

ID of the Credential document to retrieve.

Return value

Type Description

Ref<Credential>

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

Examples

Credential.byId("401328088781160521")
{
  id: "401328088768577609",
  coll: Credential,
  ts: Time("2099-06-21T18:39:00.735Z"),
  document: Customer("111")
}
\