accessProvider.update()

Learn: Access providers

We recommend you use FSL to create and update access providers. See FSL access provider schema.

Updates an access provider.

Signature

update(data: { *: Any }) => AccessProvider

Description

Updates an AccessProvider document with fields from a provided data object.

During the update, fields from the data object are copied to the document, creating new fields or updating existing fields. The operation is similar to a merge.

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

Nested fields

Fields with nested objects in the data object are merged with the identically named nested object in the document.

Remove a field

To remove a document field, set its value in the data object to null.

Metadata fields

You can’t use this method to insert or edit the following metadata fields:

  • coll

  • ts

Staged schema

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

You can’t rename an access provider while a database has staged schema.

If the database has no staged schema, using this method is equivalent to making an unstaged schema change. Changes are applied immediately to the database’s active schema.

Avoid concurrent schema changes

Concurrent unstaged schema changes can cause contended transactions, even if the changes affect different resources. This includes unstaged changes made using:

A schema change triggers a transaction that validates the entire database schema. To avoid errors, do one of the following instead:

Parameters

Parameter Type Required Description

data

Object

Document fields for the AccessProvider document.

For supported document fields, see AccessProvider collection.

The object can’t include the following metadata fields:

* coll * ts

Return value

Type Description

AccessProvider

The updated AccessProvider document.

Examples

AccessProvider.byName("someIssuer")?.update({
  name: "someIssuer",
  issuer: "https://example.com/",
  roles: "customer"
})
{
  name: "someIssuer",
  coll: AccessProvider,
  ts: Time("2099-06-25T15:00:27.295Z"),
  jwks_uri: "https://example.com/.well-known/jwks.json",
  roles: "customer",
  issuer: "https://example.com/",
  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!