From fa0a5107c24a63baec7e929349fc478a1340d6b7 Mon Sep 17 00:00:00 2001 From: aviv926 <51673860+aviv926@users.noreply.github.com> Date: Thu, 21 Mar 2024 17:05:45 +0200 Subject: [PATCH] fix(docs): Immich quota claim note (#8151) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add a note about immich_quota_claim. * Fix * PR feedback * npm run format:fix * use ¹ --- docs/docs/administration/oauth.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/docs/administration/oauth.md b/docs/docs/administration/oauth.md index f97f8da7d6..b273f27712 100644 --- a/docs/docs/administration/oauth.md +++ b/docs/docs/administration/oauth.md @@ -67,14 +67,20 @@ Once you have a new OAuth client application configured, Immich can be configure | 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) | -| Storage Label Claim | string | preferred_username | Claim mapping for the user's storage label | -| Storage Quota Claim | string | immich_quota | Claim mapping for the user's storage | +| Storage Label Claim | string | preferred_username | Claim mapping for the user's storage label**¹** | +| Storage Quota Claim | string | immich_quota | Claim mapping for the user's storage**¹** | | Default Storage Quota (GiB) | number | 0 | Default quota for user without storage quota claim (Enter 0 for unlimited quota) | | Button Text | string | Login with OAuth | Text for the OAuth button on the web | | Auto Register | boolean | true | When true, will automatically register a user the first time they sign in | | [Auto Launch](#auto-launch) | boolean | false | When true, will skip the login page and automatically start the OAuth login process | | [Mobile Redirect URI Override](#mobile-redirect-uri) | URL | (empty) | Http(s) alternative mobile redirect URI | +:::note Claim Options [1] + +Claim is only used on user creation and not synchronized after that. + +::: + :::info The Issuer URL should look something like the following, and return a valid json document.