Roles

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

Reference

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:

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!