Login

Login( identity, credentials )
Login( identity, credentials )
Login( identity, credentials )
Login( identity, credentials )
login( identity, credentials )
login( identity, credentials )
Login( identity, credentials )
Login( identity, credentials )

Description

The Login function creates an authentication token for the provided Ref, or Set of Refs.

Parameters

Argument Type Definition and Requirements

identity

Ref or Set

The identity or identities to authenticate.

credentials

Object

An object, where the only key is password and its value is a password string, to be used for authentication.

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!