AccessProvider

Description

AccessProvider is a native collection of user-defined access providers. Access provider documents are used for external authentication that involves an identity provider (IdP).

An access provider document configures half of the relationship required to authenticate with an IdP. The other half of the relationship is configured in the IdP. Authorization to resources is supported by the Fauna Role collection.

Unlike user-defined collections, the document structure for the AccessProvider collection is Fauna-defined and immutable. Provider documents are accessed by their name parameter, which makes this collection a part of the subset of native collections known as named collections.

See the AccessProvider document definition

Static methods

Method Description

AccessProvider.all()

Get the set of all access providers.

AccessProvider.byName()

Get an access provider by its name.

AccessProvider.create()

Create an access provider.

AccessProvider.firstWhere()

Get the first provider matching a predicate function.

AccessProvider.toString()

Get the name of the AccessProvider collection as a string.

AccessProvider.where()

Get providers matching a predicate function.

Instance methods

Method Description

delete()

Delete an access provider.

exists()

Tests if an access provider exists.

replace()

Replace an access provider.

update()

Update an access provider.

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!