Role

Role( name, [database] )

Description

The Role function returns a Reference for the specified user-defined role’s name in the specified child database. If a child database is not specified, the role returned belongs to the current database.

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

Parameters

Argument Type Definition and requirements

name

String

The name of a role.

database

Reference

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

Returns

A reference to a user-defined role with the specified name, in the specified child database (or the current database if database is not specified).

Examples

The following query gets a reference to the user-defined role named "admin" in the current database:

client.query(q.Role('admin'))
.then((result) => console.log(result))
Ref(id=admin, collection=Ref(id=roles))

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve! documentation@fauna.com

Thank you for your feedback!