Skip to content

High performance self-hosted photo and video management solution.

chore: update oauth documentation (#25907)

Jason Rasmussen237ea3aedd69
diff --git a/docs/docs/administration/oauth.md b/docs/docs/administration/oauth.md
index 47f4a96c6a..d0a9ce733e 100644
--- a/docs/docs/administration/oauth.md
+++ b/docs/docs/administration/oauth.md
@@ -56,11 +56,13 @@ Once you have a new OAuth client application configured, Immich can be configure
| Setting | Type | Default | Description |
| ---------------------------------------------------- | ------- | -------------------- | ----------------------------------------------------------------------------------- |
| Enabled | boolean | false | Enable/disable OAuth |
-| Issuer URL | URL | (required) | Required. Self-discovery URL for client (from previous step) |
-| Client ID | string | (required) | Required. Client ID (from previous step) |
-| Client Secret | string | (required) | Required. Client Secret (previous step) |
-| Scope | string | openid email profile | Full list of scopes to send with the request (space delimited) |
-| Signing Algorithm | string | RS256 | The algorithm used to sign the id token (examples: RS256, HS256) |
+| `issuer_url` | URL | (required) | Required. Self-discovery URL for client (from previous step) |
+| `client_id` | string | (required) | Required. Client ID (from previous step) |
+| `client_secret` | string | (required) | Required. Client Secret (previous step) |
+| `scope` | string | openid email profile | Full list of scopes to send with the request (space delimited) |
+| `id_token_signed_response_alg` | string | RS256 | The algorithm used to sign the id token (examples: RS256, HS256) |
+| `userinfo_signed_response_alg` | string | none | The algorithm used to sign the userinfo response (examples: RS256, HS256) |
+| Request timeout | string | 30,000 (30 seconds) | Number of milliseconds to wait for http requests to complete before giving up |
| Storage Label Claim | string | preferred_username | Claim mapping for the user's storage label**¹** |
| Role Claim | string | immich_role | Claim mapping for the user's role. (should return "user" or "admin")**¹** |
| Storage Quota Claim | string | immich_quota | Claim mapping for the user's storage**¹** |
diff --git a/web/src/lib/components/admin-settings/AuthSettings.svelte b/web/src/lib/components/admin-settings/AuthSettings.svelte
index 098ce23259..aec1761998 100644
--- a/web/src/lib/components/admin-settings/AuthSettings.svelte
+++ b/web/src/lib/components/admin-settings/AuthSettings.svelte
@@ -105,7 +105,7 @@
<SettingInputField
inputType={SettingInputFieldType.TEXT}
- label="ISSUER_URL"
+ label="issuer_url"
bind:value={configToEdit.oauth.issuerUrl}
required={true}
disabled={disabled || !configToEdit.oauth.enabled}
@@ -114,7 +114,7 @@
<SettingInputField
inputType={SettingInputFieldType.TEXT}
- label="CLIENT_ID"
+ label="client_id"
bind:value={configToEdit.oauth.clientId}
required={true}
disabled={disabled || !configToEdit.oauth.enabled}
@@ -123,7 +123,7 @@
<SettingInputField
inputType={SettingInputFieldType.TEXT}
- label="CLIENT_SECRET"
+ label="client_secret"
description={$t('admin.oauth_client_secret_description')}
bind:value={configToEdit.oauth.clientSecret}
disabled={disabled || !configToEdit.oauth.enabled}
@@ -132,7 +132,7 @@
{#if configToEdit.oauth.clientSecret}
<SettingSelect
- label="TOKEN_ENDPOINT_AUTH_METHOD"
+ label="token_endpoint_auth_method"
bind:value={configToEdit.oauth.tokenEndpointAuthMethod}
disabled={disabled || !configToEdit.oauth.enabled || !configToEdit.oauth.clientSecret}
isEdited={!(configToEdit.oauth.tokenEndpointAuthMethod === config.oauth.tokenEndpointAuthMethod)}
@@ -146,7 +146,7 @@
<SettingInputField
inputType={SettingInputFieldType.TEXT}
- label="SCOPE"
+ label="scope"
bind:value={configToEdit.oauth.scope}
required={true}
disabled={disabled || !configToEdit.oauth.enabled}
@@ -155,7 +155,7 @@
<SettingInputField
inputType={SettingInputFieldType.TEXT}
- label="ID_TOKEN_SIGNED_RESPONSE_ALG"
+ label="id_token_signed_response_alg"
bind:value={configToEdit.oauth.signingAlgorithm}
required={true}
disabled={disabled || !configToEdit.oauth.enabled}
@@ -164,7 +164,7 @@
<SettingInputField
inputType={SettingInputFieldType.TEXT}
- label="USERINFO_SIGNED_RESPONSE_ALG"
+ label="userinfo_signed_response_alg"
bind:value={configToEdit.oauth.profileSigningAlgorithm}
required={true}
disabled={disabled || !configToEdit.oauth.enabled}