Roles

Copied!
( [database] )

Description

The Roles function, when executed with Paginate, returns an array of References for user-defined roles in the specified child database. If a child database is not specified, the role references returned all belong to the current database.

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

Parameters

Argument Type Definition and requirements

database

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

Returns

An Set reference for the available user-defined roles in the specified child database (or the current database if database is not specified).

Examples

The following query gets the references to all user-defined roles in the current database:

Copied!
client.query(q.())
.then((result) => console.log(result))
[Ref(id=admin, collection=(id=roles))]

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!