AccessProvider.byName()

Learn: Access providers

Get an access provider by its name.

Signature

AccessProvider.byName(name: string) => NamedRef<AccessProvider>

Description

Gets an AccessProvider document by its name.

AccessProvider documents are FQL versions of a database’s FSL access provider schema. AccessProvider documents have the AccessProvider type. See Access providers.

Staged schema

If a database has staged schema, this method interacts with the database’s staged schema, not the active schema.

Parameters

Parameter Type Required Description

name

String

Yes

Name of an AccessProvider document.

Return value

Type Description

NamedRef<AccessProvider>

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

Examples

AccessProvider.byName("someIssuer")
{
  name: "someIssuer",
  coll: AccessProvider,
  ts: Time("2099-06-25T14:57:23.125Z"),
  roles: [
    "customer",
    {
      role: "manager",
      predicate: "(jwt) => jwt!.scope.includes(\"manager\")"
    }
  ],
  issuer: "https://example.com/",
  jwks_uri: "https://example.com/.well-known/jwks.json",
  audience: "https://db.fauna.com/db/ysjowue14yyr1"
}

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!