How do I obtain authorization tokens?
An auth-token
and refresh-token
is a valid JSON Web Token provided by FeatureBase after the user is authenticated.
These tokens are used to authenticate your user when TLS authentication is enabled, and with the following features:
- HTTPS API
- gRPC API
- Backup FeatureBase
- Restore FeatureBase from backup
- Grafana connector authentication
NEVER share your auth-token
or refresh-token
. These identify and authenticate you with FeatureBase and can be misused.
Table of contents
Before you begin
- Learn how to enable TLS authentication
- Set up a password manager or other safe storage for your tokens
- cd to
*/featurebase/opt
Syntax
featurebase auth-token
[
[--h | --help]
[--host string `hostname`]
[<tls-authentication-flags>]
]
Flags
Flag | Data type | Description | Default | Required | Additional information |
h or help | Auth token help | Optional | |||
host string | HTTPS host string featurebase-host:port | Yes | Default: https://localhost:10101 |
TLS authentication flags
Flag | Data type | Description | Default | Required | |
---|---|---|---|---|---|
--tls.ca-certificate | string | Path to CA certificate file on the target FeatureBase instance, or literal PEM data. | Yes | ||
--tls.certificate | string | Path to certificate file on the target FeatureBase instance, or literal PEM data. | Yes | ||
--tls.enable-client-verification | Enable verification of client certificates. | Yes | |||
--tls.key | string | Path to certificate key file on the target FeatureBase instance, or literal PEM data. | Yes | ||
--tls.skip-verify | Disables verification of server certificates. | Use for self-signed certificates. | Optional |
Further information
- Use tokens to Backup an authenticated FeatureBase cluster
- Use an
auth-token
to restore from an authenticated backup