Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions docs/accounts/developer/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,19 @@ You can manage your API tokens, rotate your database password, and reset authent

### Tokens

You can create non-expiring API tokens for your user account. You can use these tokens to access the
You can create API tokens for your user account. You can use these tokens to access the
[Turbot Pipes API](/pipes/docs/develop/query-api), or to connect to Turbot Pipes
workspaces from the Steampipe CLI. You can have up to 2 tokens at a time.
workspaces from the Steampipe CLI. You can have up to 5 tokens at a time.

Click **New Token** to create a new API token. The token will be masked, but you
can reveal it by clicking the eye icon or hovering over it and clicking the clipboard
icon to copy it. Make a secure note of the token, as you will not be able to
retrieve it again.
Click **New Token** to create a new API token. You will be prompted to enter an optional `Title` and select an `Expiration` date for the token. The expiration can be set to a specific duration or to `Never`, which means the token will not expire.

<img src="/images/docs/pipes/cloud-user-create-token.png" width="200pt"/>
<br />

> [!NOTE]
> If you're on an [Enterprise Plan](/pipes/docs/accounts/tenant#enterprise-plan) with a custom [Tenant](/pipes/docs/accounts/tenant), the [Maximum Token Expiration](/pipes/docs/accounts/tenant/authentication#maximum-token-expiration) setting will apply to the token expiration.

The token will be masked, but you can reveal it by clicking the eye icon or hovering over it and clicking the clipboard icon to copy it. Make a secure note of the token, as you will not be able to retrieve it again.

You can deactivate or delete a token from the list by clicking the options menu
button ('three dots' button) and selecting **Deactivate** or **Delete** from the menu.
Expand Down
18 changes: 16 additions & 2 deletions docs/accounts/tenant/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,30 @@ You can enable GitHub authentication by toggling the radio button. When GitHub
### Google
You can enable Google authentication by toggling the radio button. When Google authentication is enabled, any user who has been authenticated by Google whose email address is from a [trusted login domain](#trusted-login-domains) will be able to log in to your tenant - they do not need to be invited. A user will be created the first time they log in to Pipes, and they will be assigned the [Member role](/pipes/docs/accounts/tenant/people#tenant-roles) in the tenant.

## Maximum Token Expiration

You can configure the maximum duration of tokens issued to users in your tenant. This setting applies to both temporary tokens issued via the console (browser) or CLI and user access tokens managed via their profile settings.

The default value is `Never`. This allows tokens to be issued without expiration.

<img src="/images/docs/pipes/cloud-tenant-max-token-expiration.png" width="400pt"/>
<br />


> [!NOTE]
> You cannot set this value to be less than the [session timeout](#session-timeout) values. Changing this setting will not affect existing tokens which are valid until they expire or [authentication is reset](#reset-authentication).

## Session Timeout

You can configure the maximum duration of Console (browser) and CLI sessions in your tenant, after which the user will be required to log in again.

To set the session timeout, select the desired duration or select custom (hours) for the **Console Session Timeout** or **CLI Session Timeout** and click **Save**. The default value is `30 Days`.
To set the session timeout, select the desired duration or select custom to provide your own for the **Console Session Timeout** or **CLI Session Timeout** and click **Save**. The default value is `30 Days`.

<img src="/images/docs/pipes/cloud-tenant-session-timeout.png" width="400pt"/>
<br />

> Note: This setting will only apply to new user sessions. Existing user sessions will not be affected until they expire, the user logs out or [authentication is reset](#reset-authentication).
> [!NOTE]
> This setting will only apply to new user sessions. Existing user sessions will not be affected until they expire, the user logs out or [authentication is reset](#reset-authentication).

## Reset Authentication

Expand Down
Binary file added images/cloud-tenant-max-token-expiration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/cloud-tenant-session-timeout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud-tenant-workspace-configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/cloud-user-create-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.