OpenWebUI/open-webui-custom
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat/enh: api keys user permission

Browse Source 
breaking change, `ENABLE_API_KEY` renamed to `ENABLE_API_KEYS` and disabled by default and must be explicitly toggled on.
This commit is contained in:
Timothy Jaeryang Baek
2025-11-19 01:50:52 -05:00
parent f89c170566
commit 7031bb9067
10 changed files with 90 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/lib/components/admin/Settings/General.svelte
View File

@@ -338,21 +338,21 @@
</div>
<div class="mb-2.5 flex w-full justify-between pr-2">
<div class=" self-center text-xs font-medium">{$i18n.t('Enable API Key')}</div>
<div class=" self-center text-xs font-medium">{$i18n.t('Enable API Keys')}</div>
<Switch bind:state={adminConfig.ENABLE_API_KEY} />
<Switch bind:state={adminConfig.ENABLE_API_KEYS} />
</div>
{#if adminConfig?.ENABLE_API_KEY}
{#if adminConfig?.ENABLE_API_KEYS}
<div class="mb-2.5 flex w-full justify-between pr-2">
<div class=" self-center text-xs font-medium">
{$i18n.t('API Key Endpoint Restrictions')}
</div>
<Switch bind:state={adminConfig.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS} />
<Switch bind:state={adminConfig.ENABLE_API_KEYS_ENDPOINT_RESTRICTIONS} />
</div>
{#if adminConfig?.ENABLE_API_KEY_ENDPOINT_RESTRICTIONS}
{#if adminConfig?.ENABLE_API_KEYS_ENDPOINT_RESTRICTIONS}
<div class=" flex w-full flex-col pr-2 mb-2.5">
<div class=" text-xs font-medium">
{$i18n.t('Allowed Endpoints')}
@@ -362,7 +362,7 @@
class="w-full mt-1 text-sm dark:text-gray-300 bg-transparent outline-hidden"
type="text"
placeholder={`e.g.) /api/v1/messages, /api/v1/channels`}
bind:value={adminConfig.API_KEY_ALLOWED_ENDPOINTS}
bind:value={adminConfig.API_KEYS_ALLOWED_ENDPOINTS}
/>
<div class="mt-2 text-xs text-gray-400 dark:text-gray-500">

1
src/lib/components/admin/Users/Groups/EditGroupModal.svelte
View File

@@ -77,6 +77,7 @@
temporary_enforced: false
},
features: {
api_keys: false,
direct_tool_servers: false,
web_search: true,
image_generation: true,

17
src/lib/components/admin/Users/Groups/Permissions.svelte
View File

@@ -48,6 +48,7 @@
temporary_enforced: false
},
features: {
api_keys: false,
direct_tool_servers: false,
web_search: true,
image_generation: true,
@@ -613,6 +614,22 @@
<div>
<div class=" mb-2 text-sm font-medium">{$i18n.t('Features Permissions')}</div>
<div class="flex flex-col w-full">
<div class="flex w-full justify-between my-1">
<div class=" self-center text-xs font-medium">
{$i18n.t('API Keys')}
</div>
<Switch bind:state={permissions.features.api_keys} />
</div>
{#if defaultPermissions?.features?.api_keys && !permissions.features.api_keys}
<div>
<div class="text-xs text-gray-500">
{$i18n.t('This is a default user permission and will remain enabled.')}
</div>
</div>
{/if}
</div>
<div class="flex flex-col w-full">
<div class="flex w-full justify-between my-1">
<div class=" self-center text-xs font-medium">

8
src/lib/components/chat/Settings/Account.svelte
View File

@@ -242,7 +242,7 @@
</div>
{/if}
{#if ($config?.features?.enable_api_key ?? true) || $user?.role === 'admin'}
{#if ($config?.features?.enable_api_keys ?? true) && ($user?.role === 'admin' || ($user?.permissions?.features?.api_keys ?? false))}
<div class="flex justify-between items-center text-sm mt-2">
<div class=" font-medium">{$i18n.t('API keys')}</div>
<button
@@ -255,9 +255,9 @@
</div>
{#if showAPIKeys}
<div class="flex flex-col py-2.5">
<div class="flex flex-col">
{#if $user?.role === 'admin'}
<div class="justify-between w-full">
<div class="justify-between w-full mt-2">
<div class="flex justify-between w-full">
<div class="self-center text-xs font-medium mb-1">{$i18n.t('JWT Token')}</div>
</div>
@@ -312,7 +312,7 @@
</div>
{/if}
{#if $config?.features?.enable_api_key ?? true}
{#if ($config?.features?.enable_api_keys ?? true) && ($user?.role === 'admin' || ($user?.permissions?.features?.api_keys ?? false))}
<div class="justify-between w-full mt-2">
{#if $user?.role === 'admin'}
<div class="flex justify-between w-full">

2
src/lib/stores/index.ts
View File

@@ -264,7 +264,7 @@ type Config = {
features: {
auth: boolean;
auth_trusted_header: boolean;
enable_api_key: boolean;
enable_api_keys: boolean;
enable_signup: boolean;
enable_login_form: boolean;
enable_web_search?: boolean;