Skip to content

Commit fa0a510

Browse files
authored
fix(docs): Immich quota claim note (#8151)
* Add a note about immich_quota_claim. * Fix * PR feedback * npm run format:fix * use ¹
1 parent dc3c329 commit fa0a510

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

Diff for: docs/docs/administration/oauth.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,20 @@ Once you have a new OAuth client application configured, Immich can be configure
6767
| Client Secret | string | (required) | Required. Client Secret (previous step) |
6868
| Scope | string | openid email profile | Full list of scopes to send with the request (space delimited) |
6969
| Signing Algorithm | string | RS256 | The algorithm used to sign the id token (examples: RS256, HS256) |
70-
| Storage Label Claim | string | preferred_username | Claim mapping for the user's storage label |
71-
| Storage Quota Claim | string | immich_quota | Claim mapping for the user's storage |
70+
| Storage Label Claim | string | preferred_username | Claim mapping for the user's storage label**¹** |
71+
| Storage Quota Claim | string | immich_quota | Claim mapping for the user's storage**¹** |
7272
| Default Storage Quota (GiB) | number | 0 | Default quota for user without storage quota claim (Enter 0 for unlimited quota) |
7373
| Button Text | string | Login with OAuth | Text for the OAuth button on the web |
7474
| Auto Register | boolean | true | When true, will automatically register a user the first time they sign in |
7575
| [Auto Launch](#auto-launch) | boolean | false | When true, will skip the login page and automatically start the OAuth login process |
7676
| [Mobile Redirect URI Override](#mobile-redirect-uri) | URL | (empty) | Http(s) alternative mobile redirect URI |
7777

78+
:::note Claim Options [1]
79+
80+
Claim is only used on user creation and not synchronized after that.
81+
82+
:::
83+
7884
:::info
7985
The Issuer URL should look something like the following, and return a valid json document.
8086

0 commit comments

Comments
 (0)