Login
Login( identity, param_object )
Login( identity, param_object )
Login( identity, param_object )
Login( identity, param_object )
login( identity, param_object )
login( identity, param_object )
Login( identity, param_object )
Login( identity, param_object )
Description
The Login
function creates an authentication token for the provided
identity
, which can be a Ref or a
Set of refs, based on the password provided in
param_object
.
The authentication token’s secret can be used to connect to FaunaDB and
execute queries within the database that contains identity
. The
permissions granted to the authentication token can be specified using
Attribute-based access control (ABAC).
Parameters
Argument | Type | Definition and Requirements |
---|---|---|
|
The identity (reference to a document) or identities (set of refs to multiple documents) to authenticate. |
|
|
The |
param_object
Field Name | Field Type | Definition and Requirements |
---|---|---|
|
Optional - a document storing metadata about the token to be created. |
|
|
The password to authenticate |
|
|
Optional - A timestamp indicating the authentication token’s time-to-live, that is when the token should be removed. When a token is removed, the token’s existence ceases (temporal queries cannot recover the token) and the associated secret can no longer be used to authenticate. Token removal is handled by a background task, so once the |
Returns
When authentication is successful, an object containing the authenticated Ref(s) is returned. When authentication fails, an error is returned.
Examples
curl https://db.fauna.com/ \
-u fnAChGwBcAACAO70ziE0cfROosNJHdgBmJU1PgpL: \
-d '{
"login": { "@ref": "classes/characters/181388642114077184" },
"params": { "object": { "password": "abracadabra" } }
}'
client.Query(
Login(
Ref(Collection("characters"), "181388642114077184"),
Obj("password", "abracadabra")));
System.out.println(
client.query(
Login(
Ref(Collection("characters"), Value(181388642114077184L)),
Obj("password", Value("abracadabra")))
).get());
result, _ := client.Query(
f.Login(
f.RefCollection(f.Collection("characters"), "181388642114077184"),
f.Obj{"password": "abracadabra"},
),
)
fmt.Println(result)
client.query(
Login(
Ref(Collection("characters"), "181388642114077184"),
Obj("password" -> "abracadabra")))
client.query(
q.login(
q.ref(q.collection("characters"), "181388642114077184"),
{"password": "abracadabra"}
))
$client.query do
login ref(collection('characters'), '181388642114077184'),
password: 'abracadabra'
end
client.query(
Login(
for: Ref(Collection("characters"), "181388642114077184"),
Obj("password" => "abracadabra")
)
)
client.query(
q.Login(
q.Ref(q.Collection('characters'), '181388642114077184'),
{ password: 'abracadabra' },
)
)
.then((ret) => console.log(ret))
HTTP/1.1 201 Created
{
"resource": {
"ref": { "@ref": "tokens/181388643175236096" },
"class": { "@ref": "tokens" },
"ts": 1509244540264619,
"document": { "@ref": "classes/characters/181388642114077184" },
"secret": "fnEChGwCisACAAKEbAFuUAIAwIxOcffRgoJm7EgUt_zlmiPOze4"
}
}
{
"ref": { "@ref": "tokens/181388643175236096" },
"class": { "@ref": "tokens" },
"ts": 1509244540264619,
"document": { "@ref": "classes/characters/181388642114077184" },
"secret": "fnEChGwCisACAAKEbAFuUAIAwIxOcffRgoJm7EgUt_zlmiPOze4"
}
{
ref: ref(id = "210072853209416192", collection = ref(id = "tokens")),
ts: 1536599934671870,
document: ref(id = "181388642114077184", collection = ref(id = "characters", collection = ref(id = "collections"))),
secret: "fnEC6lQloIACAALqVCVT8AIAtHiABBu-jZoAKERviRRl5bjZNBQ"
}
map[ref:{181388643175236096 0xc4202b3440 <nil>} ts:1509244540264619 document:{181388642114077184 0xc4202b36c0 <nil>} secret:fnEChGwCisACAAKEbAFuUAIAwIxOcffRgoJm7EgUt_zlmiPOze4]
{
"ref": { "@ref": "tokens/181388643175236096" },
"class": { "@ref": "tokens" },
"ts": 1509244540264619,
"document": { "@ref": "classes/characters/181388642114077184" },
"secret": "fnEChGwCisACAAKEbAFuUAIAwIxOcffRgoJm7EgUt_zlmiPOze4"
}
{
"ref": { "@ref": "tokens/181388643175236096" },
"class": { "@ref": "tokens" },
"ts": 1509244540264619,
"document": { "@ref": "classes/characters/181388642114077184" },
"secret": "fnEChGwCisACAAKEbAFuUAIAwIxOcffRgoJm7EgUt_zlmiPOze4"
}
{
"ref": { "@ref": "tokens/181388643175236096" },
"class": { "@ref": "tokens" },
"ts": 1509244540264619,
"document": { "@ref": "classes/characters/181388642114077184" },
"secret": "fnEChGwCisACAAKEbAFuUAIAwIxOcffRgoJm7EgUt_zlmiPOze4"
}
{
"ref": { "@ref": "tokens/181388643175236096" },
"class": { "@ref": "tokens" },
"ts": 1509244540264619,
"document": { "@ref": "classes/characters/181388642114077184" },
"secret": "fnEChGwCisACAAKEbAFuUAIAwIxOcffRgoJm7EgUt_zlmiPOze4"
}
{ ref: Ref(id=181388643175236096, collection=Ref(id=tokens)),
ts: 1527279532953934,
document:
Ref(id=181388642114077184, collection=Ref(id=characters, collection=Ref(id=collections))),
secret: 'fnECx5uE8OACAQLCZP7uQAIBF3rvpXoJEzfIrNXEL21PUpib9AE' }
Was this article helpful?
We're sorry to hear that.
Tell us how we can improve!
documentation@fauna.com
Thank you for your feedback!