Roles

Roles( [database] )
Roles( [database] )
Roles( [database] )
Roles( [database] )
roles( [database] )
Roles( [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:

client.Query(
    Roles()
);
RefV(id = "roles")
result, err := client.Query(
	f.Roles())

if err != nil {
	fmt.Fprintln(os.Stderr, err)
} else {
	fmt.Println(result)
}
&{roles <nil> <nil> <nil>}
System.out.println(
    client.query(
        Roles()
    ).get());
ref(id = "roles")
client.query(
  q.Roles()
)
.then((result) => console.log(result))
.catch((err) => console.error('Error: %s', err))
Roles()
result = client.query(
  q.roles()
)
print(result)
Ref(id=roles)
client.query(Roles())
ref(id = "roles")

Was this article helpful?

We're sorry to hear that.
Tell us how we can improve!
Visit Fauna's Discourse forums or email docs@fauna.com

Thank you for your feedback!