AccessProviders

Copied!
( [database] )

Description

The AccessProviders function, when executed with Paginate, returns the set of References for all AccessProviders in the specified child database. If a child database is not specified, the returned index references all belong to the current database.

When a child database is specified, an admin key must be used to call AccessProviders (server or client keys, or ABAC tokens, cannot be used to access a child database).

Parameters

Parameter Type Definition and Requirements

database

Reference

Optional - A Reference to a child database. If not specified, the current database is used.

Returns

A Set Reference for the available AccessProviders in the specified child database (or the current database if database is not specified).

Examples

  1. The following query gets the references to all AccessProviders in the current database:

    Copied!
    client.query(
  q.(q.())
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
    { data: [ ("Auth0-myapp") ] }
    Query metrics:

    •    bytesIn:  38

    •   bytesOut: 101

    • computeOps:   1

    •    readOps:   8

    •   writeOps:   0

    •  readBytes: 250

    • writeBytes:   0

    •  queryTime: 8ms

    •    retries:   0

  2. The following query demonstrates what happens when no AccessProviders exist:

    Copied!
    client.query(
  q.(q.())
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
    { data: [] }
    Query metrics:

    •    bytesIn:    38

    •   bytesOut:    24

    • computeOps:     1

    •    readOps:     8

    •   writeOps:     0

    •  readBytes:   208

    • writeBytes:     0

    •  queryTime: 378ms

    •    retries:     0

  3. The following query lists the References for any AccessProviders (up to the pagination limit) within a child database named "child_db":

    Copied!
    client.query(
  q.(q.(q.('child_db')))
)
.then((ret) => console.log(ret))
.catch((err) => console.error(
  'Error: [%s] %s: %s',
  err.name,
  err.message,
  err.errors()[0].description,
))
    { data: [] }
    Query metrics:

    •    bytesIn:   57

    •   bytesOut:   24

    • computeOps:    1

    •    readOps:    8

    •   writeOps:    0

    •  readBytes:  382

    • writeBytes:    0

    •  queryTime: 21ms

    •    retries:    0

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!