AccessProvider.byName()

Get an AccessProvider document by its name.

Signature

AccessProvider.byName(name: string): AccessProvider | NullAccessProvider

Description

Gets the named AccessProvider document.

Parameters

Parameter Type Required Description

name

String

Yes

Name of the access provider.

Return value

One of:

Type Description

AccessProvider

An access provider.

NullAccessProvider

Document doesn’t exist or is inaccessible. See NullDoc.

Examples

AccessProvider.byName("anAccessProvider")
{
  name: "anAccessProvider",
  coll: AccessProvider,
  ts: Time("2023-07-28T03:46:30.150Z"),
  issuer: "https://fauna.auth0.com",
  audience: "https://db.fauna.com/db/ywtfhw4poyynr",
  jwks_uri: "https://fauna.auth0.com/.well-known/jwks.json",
  roles: [
    "mgmtTeam",
    {
      role: "mgmtTeam",
      predicate: "_ => true"
    }
  ],
  data: {
    custom: "some data"
  }
}

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!