> ## Documentation Index
> Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Account Security Settings
> Manage session timeout, audit logs, two-factor authentication, and enterprise access controls.
***
Use account security settings to manage how users access your workspace, how long sessions stay active, and how administrators review important account activity.
Automatically log users out after a period of inactivity.
Add an extra verification step when users log in.
Track workspace activity and security-related events.
Connect enterprise identity providers through Single Sign-On.
***
## Accessing Your Settings
All the settings on this page live in your **Settings**. To open them, click your **profile card** at the bottom-left corner of the sidebar, then select **Settings**.
From there, use the left menu: the **Security** tab (under *User*) for 2FA and password, and **General Settings** or **Audit Log** (under *Workspace*) for session timeout and activity logs.
***
## Customizing Your Session Timeout
You can configure how long a session remains active before the user is automatically logged out due to inactivity. This helps protect your account if you forget to log out, especially when using a shared or public device.
The session timeout is set in **minutes**, with a minimum of **30 minutes** and a maximum of **3 days**.
This is a **workspace-level** setting managed by the **workspace owner**. The value applies to **all members** of the workspace, not just the account that changes it.
Go to **Settings > General Settings** under the *Workspace* section.
In the **Session Timeout** field, enter the duration in minutes and click **Update**.
Shorter session timeouts are recommended for shared devices, public computers, or workspaces with stricter security policies.
***
## Reviewing Workspace Activity with Audit Logs
The **Audit Log** helps administrators review important activity and security events in the workspace. It is useful for monitoring sign-ins, configuration changes, published Pearls, and other account-level events.
To access it, go to **Settings > Audit Log** under the *Workspace* section.
Each entry in the log includes:
* **Timestamp**: when the event happened.
* **Event Type**: the kind of action recorded, such as a successful login or published Pearl.
* **User**: the workspace member who triggered the event.
* **Details**: additional context about the action, when available.
### Recorded event types
The audit log records the following events. The **Event Type** filter uses the same labels shown below.
#### Pearls
| Event type | Description |
| - | - |
| Publish Pearl | A Pearl was published. |
| Pearl Status | A Pearl's status was changed. |
| Pearl Retention | A Pearl's data retention settings were changed. |
| Pearl Total Agents | The number of agents assigned to a Pearl was changed. |
| Pearl Budget | A Pearl's budget was changed. |
| Pearl Phone Number | A Pearl's phone number was changed. |
| Transfer Pearl | A Pearl was transferred. |
| Delete Pearl | A Pearl was deleted. |
#### API keys
| Event type | Description |
| - | - |
| Create API Key | An API secret key or an OAuth 2.0 app was created. |
| Update API Key | An OAuth 2.0 app's scopes were changed. |
| Rotate API Key Secret | An OAuth 2.0 app's client secret was rotated. The secret value is not stored in the log. |
| Delete API Key | An API secret key or an OAuth 2.0 app was deleted. |
| Reveal API Key | An API key was revealed. The secret value is not stored in the log. |
#### Users and roles
| Event type | Description |
| - | - |
| Invite User | A user was invited to the workspace. |
| User Join | A user joined the workspace. |
| Invitation Canceled | A pending invitation was canceled. |
| Update User Role | A user's role was changed. |
| Update Account Information | Workspace account information was changed. |
| Remove User from Account | A user was removed from the workspace. |
| User Left Account | A user left the workspace. |
| Create Role | A workspace role was created. |
| Update Role | A workspace role or its permissions were changed. |
| Delete Role | A workspace role was deleted. |
#### Security
| Event type | Description |
| - | - |
| Login Attempt | A user attempted to sign in. |
| Login Successful | A user signed in successfully. |
| Update Session TTL | The workspace session timeout was changed. |
| Set 2FA | Two-factor authentication settings were changed. |
| Change Password | A user changed their password. |
| Delete Account | The workspace account was deleted. |
| Add to Blacklist | One or more phone numbers were added to the blacklist. |
| Remove from Blacklist | One or more phone numbers were removed from the blacklist. |
#### Billing and agents
| Event type | Description |
| - | - |
| Purchase Agents | Agents were purchased. |
| Delete Agent | An agent was removed. |
| Set Billing Details | Workspace billing details were changed. |
| Set Payment Method | The workspace payment method was changed. |
| Set Subscription | The workspace subscription was changed. |
| Cancel Subscription | The workspace subscription was canceled. |
| Purchase Credits | Credits were purchased. |
| Set Auto Recharge | Automatic credit recharge settings were changed. |
#### Phone numbers
| Event type | Description |
| - | - |
| Purchase Phone Numbers | One or more phone numbers were purchased. |
| Release Phone Number | A phone number was released. |
| Add Phone Number | A bring-your-own phone number was added. |
| Update Phone Number | A phone number's settings were changed. |
| Update SIP Configuration | SIP settings for a phone number were changed. |
| Set Twilio Credentials | Workspace Twilio credentials were changed. |
#### Text channels and integrations
| Event type | Description |
| - | - |
| Create Text Channel | A text channel was created. |
| Update Text Channel | A text channel was changed. |
| Delete Text Channel | A text channel was deleted. |
| Rotate Channel Secret | A text channel secret was rotated. |
| Reveal Channel Secret | A text channel secret was revealed. The secret value is not stored in the log. |
| Connect WhatsApp | A WhatsApp integration was connected. |
| Add WhatsApp Number | A phone number was added to a WhatsApp integration. |
| Disconnect WhatsApp | A WhatsApp integration was disconnected. |
| Set Email Credentials | Email credentials were configured. |
| Delete Email Credentials | Email credentials were removed. |
| Connect Slack | A Slack integration was connected. |
| Connect Calendar | A calendar integration was connected. |
#### Data and groups
| Event type | Description |
| - | - |
| Import Leads | Leads were imported into a Pearl. |
| Delete Leads | Leads were deleted from a Pearl. |
| Delete Calls | Calls were deleted from a Pearl. |
| Export Calls | Calls were exported from a Pearl. |
| Group Retention | A group's contact retention settings were changed. |
| Delete Contacts | Group contacts were purged by the retention policy. |
Use the **date range** and **Event Type** filters at the top right to narrow the audit log when investigating a specific time period or activity.
***
## Enterprise Single Sign-On (SSO)
Single Sign-On (SSO) is available for Enterprise workspaces. It allows your team to authenticate through your company identity provider and centralize access management.
To enable SSO for your workspace, contact us at [support@nlpearl.ai](mailto:support@nlpearl.ai). Please include your workspace name, company domain, and preferred identity provider if available.
Once SSO is enabled, members sign in with the **Sign in with SSO** button on the login screen instead of entering a password.
***
## Two-Factor Authentication (2FA)
Two-Factor Authentication (2FA) adds an additional step to the login process to strengthen your account’s security. Instead of relying solely on your password, which could be guessed, leaked, or stolen, 2FA requires a second form of verification that only you should have access to.
Typically, this second factor is a temporary code generated by a mobile app like Google Authenticator. If you can't reach your app, you can also receive the code by **SMS** at login. Even if someone knows your password, they won’t be able to access your account without that second code. That’s why 2FA is a simple and highly effective way to safeguard your data.
In this guide, we’ll show you exactly how to activate and use Two-Factor Authentication on our platform.
***
### How to Set Up 2FA
Click your **profile card** at the bottom-left corner of the sidebar, open **Settings**, then select the **Security** tab under the *User* section.
The **Platform Security** page has two areas: the **2FA (Two-Factor Authentication)** box and a **Reset Password** section.
In the **2FA (Two-Factor Authentication)** box, click **Set up authenticator** (labeled **Reset authenticator** once 2FA is already set up) to open the QR code window.
The **Secure your NLPearl account with 2FA** window appears, showing a QR code on the right and the boxes to enter your code.
On your phone, install an authenticator app such as **Google Authenticator**, **Microsoft Authenticator**, or **Authy**.
Open the app, tap the **+** button, and choose **Scan a QR code**. Point your camera at the QR code shown in the setup window.
The app generates a **6-digit code** that refreshes every few seconds. Enter it in the setup window and click **Verify & Activate**.
Once 2FA has been set up, use the **toggle** in the 2FA box to turn it on or off for your account at any time. When it's on, you're asked for a code at every login; when it's off, 2FA is disabled but your authenticator stays configured.
Once the code is verified, 2FA is active on your account. You'll be asked for a code at every login.
Lost access to your authenticator app or got a new phone? Click **Reset authenticator** in the 2FA box (the same button used during setup) to unlink the current device and reopen the QR window to set up a new one.
Once 2FA is active, every login prompts you for a verification code:
* Enter the current 6-digit code from your **authenticator app**.
* If you can't reach your app, click **Get your code via SMS** in the prompt to receive the code by text instead.
***
## Resetting Your Password
You can update your account password at any time from the **Platform Security** page. In the **Reset Password** section, click **Reset Password** and follow the prompts.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.