Roles

Roles( [database] )
Roles( [database] )
Roles( [database] )
Roles( [database] )
roles( [database] )
roles [database]
Roles( [database] )
Roles( [database] )

Description

The Roles function returns an array of Refs for all user-defined roles in the specified database. If no database is provided, the roles returned all belong to the current database.

Parameters

Argument Type Definition and requirements

database

String

Optional. The target database. If not specified, the current database is used.

Returns

An array of references to all user-defined roles in the specified database, or the current database if no database was specified.

Examples

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

curl https://db.fauna.com/ \
    -u fnAChGwBcAACAO70ziE0cfROosNJHdgBmJU1PgpL: \
    -d '{ "roles": null }'
client.Query(Roles());
System.out.println(client.query(Roles()).get());
result, _ := client.Query(f.Roles())
fmt.Println(result)
client.query(Roles())
client.query(q.roles())
$client.query do
  roles
end
client.query(Roles())
client.query(q.Roles())
.then((result) => console.log(result))
HTTP/1.1 200 OK
{ "resource": [{ "@ref": "roles/admin" }] }
[{ "@ref": "roles/admin" }]
[ref(id = "admin", collection = ref(id = "roles"))]
[{admin 0xc4202d0fa0 <nil>}]
[{ "@ref": "roles/admin" }]
[{ "@ref": "roles/admin" }]
[{ "@ref": "roles/admin" }]
[{ "@ref": "roles/admin" }]
[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!