Security, privacy, limitations and troubleshooting

Protect the OpenAI API key

Apply least privilege and secret-handling controls to the stored credential.

Audience: CRM administrators and authorised staffPermission: Settings: EditModule v1.0.0

Where to goAdmin Area → Setup → Settings → AI → OpenAI

Before you start

Use an account with Settings: Edit and confirm the intended record or setting before making a change.
Follow the exact route above. If the screen or action is absent, check module activation, ownership and permissions rather than using another person’s account.
Use controlled test data for configuration, integration, email, AI, payment, portal or automation changes before production-wide use.

What this guide helps you do

Apply least privilege and secret-handling controls to the stored credential. The instructions reflect the supplied module’s registered menus, controller actions, views, settings and code-backed validation flow.

Follow these steps

Go to Admin Area → Setup → Settings → AI → OpenAI.
Select the exact record or option described in this guide.
Complete the displayed fields or action using the rules below.
Save or submit once and resolve any validation response.
Check the resulting record, status, file, notification or integration effect.

Fields and options

ActionProtect the OpenAI API key

Exact navigationAdmin Area → Setup → Settings → AI → OpenAI

Module version1.0.0

VerificationVerify the saved record, status, output or setting in the same workspace and review any linked activity, file or notification.

Rules and limits

The settings view renders the key as a password input.
The module has no built-in rotation, expiry or usage-metadata workflow.
Rotate through the provider account and replace the stored value when required.

Check it worked

The supported protect the openai api key flow completes without bypassing permission or validation checks.
The resulting record, setting, status, file, delivery event or external response is visible from the relevant workspace.
Unexpected validation, provider or linked-record errors are investigated before retrying.

Security, privacy and operational checks

Restrict the API key and AI settings to authorised administrators.
Do not submit confidential, special-category or unnecessary personal data to the external AI provider.
Check generated text before using it in customer, staff, legal, financial or compliance communication.
Monitor provider billing and retention independently because this module has no built-in cost dashboard.

Was this guide useful?Your response is stored only in this browser.