cloud-login
Add a Fauna endpoint with login credentials.
Description
The cloud-login
command prompts for Fauna credentials and,
if authentication is successful, creates a cloud
endpoint in the
configuration file, which is used
to query a Fauna database.
Command line prompts help create endpoints that work with Region Groups and with secrets for existing databases:
Prompt | Description | ||||
---|---|---|---|---|---|
Endpoint alias prefix |
To access databases in multiple Region Groups, this prompt requests a prefix that can be applied to multiple Region Group endpoints. |
||||
How do you prefer to authenticate? |
Authentication preference:
|
||||
Multi-factor authentication |
When multifactor authentication (MFA) is enabled for your account,
you’re prompted for the current, time-based multifactor authentication code.
Get the current code in your authenticator app. If you enter an incorrect
code, |
||||
Default endpoint |
When the configuration file has an existing endpoint, you are asked if the new endpoint to be created by this command should be the default endpoint. |
Options
Option | Description |
---|---|
|
(Optional) Fauna server domain, which is the Fauna hostname. |
|
(Optional) Endpoint name to use for the command. |
|
(Optional) Connection port. |
|
(Optional) Connection scheme. Must be one of: |
|
(Optional) Secret to use to connect to a database. |
|
(Optional) connection timeout, in milliseconds.
When the interval elapses, |
|
(Optional) Fauna Query Language version |
Examples
The following example demonstrates the use of cloud-login
and the
prompts for email/secret and password:
fauna cloud-login
? The endpoint alias prefix (to combine with a region): cloud
? How do you prefer to authenticate? Email and Password
? Email address: docs@fauna.com
? Password: [hidden]
? Enter your multi-factor authentication code 377277
? Endpoints created. Would you like to set one of them as default? Keep 'cloud'
endpoint as default
Endpoint 'cloud' set as default endpoint.
After a successful login, your
configuration file now has a
cloud
endpoint that includes the secret to access your top-level
database. The configuration file should resemble:
default=cloud
[cloud]
domain=db.fauna.com
scheme=https
secret=fnADS@PxN@2CE@n7z@kDa4_p6Z@fIBaZm@Qt@bYT
Is this article helpful?
Tell Fauna how the article can be improved:
Visit Fauna's forums
or email docs@fauna.com
Thank you for your feedback!