2017-03-21 22:24:29 +01:00
|
|
|
---
|
2017-04-03 19:53:38 +02:00
|
|
|
layout: "enterprise"
|
2017-04-07 06:01:07 +02:00
|
|
|
page_title: "Authentication - Accounts - Terraform Enterprise"
|
2017-03-21 22:24:29 +01:00
|
|
|
sidebar_current: "docs-enterprise-accounts-authentication"
|
|
|
|
description: |-
|
|
|
|
Terraform Enterprise requires a username and password to sign up and login. However, there are several ways to authenticate with your account.
|
|
|
|
---
|
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
# Authentication
|
2017-03-21 22:24:29 +01:00
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
Terraform Enterprise requires a username and password to sign up and login.
|
|
|
|
However, there are several ways to authenticate with your account.
|
2017-03-21 22:24:29 +01:00
|
|
|
|
|
|
|
### Authentication Tokens
|
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
Authentication tokens are keys used to access your account via tools or over the
|
|
|
|
various APIs used in Terraform Enterprise.
|
2017-03-21 22:24:29 +01:00
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
You can create new tokens in the token section of your account settings. It's
|
|
|
|
important to keep tokens secure, as they are essentially a password and can be
|
|
|
|
used to access your account or resources. Additionally, token authentication
|
2017-03-21 22:24:29 +01:00
|
|
|
bypasses two factor authentication.
|
|
|
|
|
|
|
|
### Authenticating Tools
|
|
|
|
|
|
|
|
All HashiCorp tools look for the `ATLAS_TOKEN` environment variable:
|
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
```shell
|
|
|
|
$ export ATLAS_TOKEN=TOKEN
|
|
|
|
```
|
2017-03-21 22:24:29 +01:00
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
This will automatically authenticate all requests against this token. This is
|
|
|
|
the recommended way to authenticate with our various tools. Care should be given
|
|
|
|
to how this token is stored, as it is as good as a password.
|
2017-03-21 22:24:29 +01:00
|
|
|
|
|
|
|
### Two Factor Authentication
|
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
You can optionally enable Two Factor authentication, requiring an SMS or TOTP
|
|
|
|
one-time code every time you log in, after entering your username and password.
|
2017-03-21 22:24:29 +01:00
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
You can enable Two Factor authentication in the security section of your account
|
|
|
|
settings.
|
2017-03-21 22:24:29 +01:00
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
Be sure to save the generated recovery codes. Each backup code can be used once
|
|
|
|
to sign in if you do not have access to your two-factor authentication device.
|
2017-03-21 22:24:29 +01:00
|
|
|
|
|
|
|
### Sudo Mode
|
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
When accessing certain admin-level pages (adjusting your user profile, for
|
|
|
|
example), you may notice that you're prompted for your password, even though
|
|
|
|
you're already logged in. This is by design, and aims to help guard protect you
|
|
|
|
if your screen is unlocked and unattended.
|
2017-03-21 22:24:29 +01:00
|
|
|
|
|
|
|
### Session Management
|
|
|
|
|
2017-04-07 06:01:07 +02:00
|
|
|
You can see a list of your active sessions on your security settings page. From
|
|
|
|
here, you can revoke sessions, in case you have lost access to a machine from
|
|
|
|
which you were accessing.
|