At line 4 changed 5 lines |
__!!!Important__: Ensure that all {{''__(Required)__''}} fields are properly configured as outlined on this wiki page.\\ |
\\ |
__!!! Proxy Configuration__: If your server accesses the internet through a proxy, ensure that the __Identity Provider__’s (IdP’s) domains are whitelisted to allow the authentication process.\\ |
\\ |
__!!! Constraints__:\\ |
---- |
__⚠️ Important__: Ensure that all {{''__(Required❗)__''}} fields are properly configured as outlined on this wiki page.\\ |
---- |
__⚠️ Proxy Configuration__: If your server accesses the internet through a proxy, ensure that the __Identity Provider__’s (IdP’s) domains are whitelisted to allow the authentication process.\\ |
---- |
__⚠️ Constraints__:\\ |
At line 19 added one line |
\\ |
At line 29 changed one line |
__!!!See details at__: [Apple Sign In Configuration]\\ |
__⚠️ See details at__: [Apple Sign In Configuration]\\ |
At line 40 changed one line |
As a reference example, see the [Google OAuth 2.0 Link| https://www.crushftp.com/crush11wiki/Wiki.jsp?page=SMTP%20Google%20Mail%20Integration#section-SMTP+Google+Mail+Integration-1.GoogleMailOAuth2.0] documentation.\\ |
As a reference example, see the [GDriveSetup] documentation.\\ |
At line 56 changed one line |
!2.1.1 OpenID Configuration URL {{''__(Required)__''}}: \\ |
!2.1.1 OpenID Configuration URL {{''__(Required❗)__''}}: \\ |
At line 61 changed one line |
• Authorization endpoint {{''__(Required)__''}}\\ |
• Authorization endpoint {{''__(Required❗)__''}}\\ |
At line 99 changed one line |
!2.1.3 Authorization related settings {{''__(Required)__''}}:\\ |
!2.1.3 Authorization related settings {{''__(Required❗)__''}}:\\ |
At line 110 changed one line |
• {oidc_redirect_url}: An autogenerated URL by CrushFTP, composed of the initial host and port, followed by __/SSO_IDC/__. This URL is used to redirect the user after successful authentication. __!!! It must exactly match the redirect URL registered and configured in the IdP.__\\ |
• {oidc_redirect_url}: An autogenerated URL by CrushFTP, composed of the initial host and port, followed by __/SSO_IDC/__. This URL is used to redirect the user after successful authentication. __⚠️ It must exactly match the redirect URL registered and configured in the IdP.__\\ |
At line 126 changed one line |
__The refresh token enables access to the user's cloud storage through the IdP. __CrushFTP supports cloud storage integration with services such as Google Drive ([GDriveSetup]), OneDrive ([OneDriveSetup]), SharePoint ([SharePoint Integration]), and Dropbox ([Dropbox Integration]).\\ |
__The refresh token enables access to the user's cloud storage through the IdP. __CrushFTP supports cloud storage integration with services such as Google Drive ([GDriveSetup]), Google Cloud Storage ([Google Cloud Storage Integration]), OneDrive ([OneDriveSetup]), SharePoint ([SharePoint Integration]), and Dropbox ([Dropbox Integration]).\\ |
At line 130 changed 2 lines |
Google: https://www.googleapis.com/auth/drive |
Dropbox: files.metadata.write files.content.write files.content.read |
Google: https://www.googleapis.com/auth/drive |
|
GStorage: https://www.googleapis.com/auth/devstorage.full_control |
|
Dropbox: files.metadata.write files.content.write files.content.read |
At line 143 changed one line |
__Verify ID Token:__ The Authorization Code Flow uses the code value returned by the IdP to obtain the ID token. Although this step is not mandatory in the OpenID protocol, you can enable an additional verification of the returned ID token by selecting this checkbox. __!!!__ This feature works only if the OpenID configuration includes the "__jwks_uri__" endpoint. __It provides an extra layer of validation for the ID token.__\\ |
__Verify ID Token:__ The Authorization Code Flow uses the code value returned by the IdP to obtain the ID token. Although this step is not mandatory in the OpenID protocol, you can enable an additional verification of the returned ID token by selecting this checkbox. ⚠️ This feature works only if the OpenID configuration includes the "__jwks_uri__" endpoint. __It provides an extra layer of validation for the ID token.__\\ |
At line 147 changed one line |
__Check User Endpoint URL?__: This option enables CrushFTP to retrieve additional information about the user from the IdP via the "__user_info__" endpoint URL. __!!!__ This feature only works if the OpenID configuration includes a "userinfo_endpoint" URL or if you manually specify it in the "__User Endpoint URL__" input field. \\ |
__Check User Endpoint URL?__: This option enables CrushFTP to retrieve additional information about the user from the IdP via the "__user_info__" endpoint URL. ⚠️ This feature only works if the OpenID configuration includes a "userinfo_endpoint" URL or if you manually specify it in the "__User Endpoint URL__" input field. \\ |
At line 151 changed one line |
__Special Case for Microsoft Azure AD:__ When using __Microsoft Azure AD__ as the Identity Provider (IdP), a specific user endpoint is required to retrieve group information for the authenticated user:\\ |
⚠️ __Special Case for Microsoft Azure AD:__ When using __Microsoft Azure AD__ as the Identity Provider (IdP), a specific user endpoint is required to retrieve group information for the authenticated user:\\ |
At line 166 changed one line |
__Claim as Username__ {{''__(Required)__''}}: Specify the name of the claim within the IdP's response that should be used as the __username for the CrushFTP session__. |
__Claim as Username__ {{''__(Required❗)__''}}: Specify the name of the claim within the IdP's response that should be used as the __username for the CrushFTP session__. |
At line 168 changed one line |
__!!!__ If this claim is not present or its value is missing in the IdP's response (either within the ID Token or retrieved from the user endpoint), __the authentication will fail due to a missing username__.\\ |
__⚠️__ If this claim is not present or its value is missing in the IdP's response (either within the ID Token or retrieved from the user endpoint), __the authentication will fail due to a missing username__.\\ |
At line 178 changed one line |
__Enable__: Activate the plugin. {{''__(Required)__''}}\\ |
__Enable__: Activate the plugin. {{''__(Required❗)__''}}\\ |
At line 184 changed one line |
!2.2.1 Login Button {{''__(Required)__''}}:\\ |
!2.2.1 Login Button {{''__(Required❗)__''}}:\\ |
At line 189 changed one line |
!2.2.2 Username matching {{''__(Required)__''}}:\\ |
!2.2.2 Username matching {{''__(Required❗)__''}}:\\ |
At line 207 changed one line |
!2.2.5 User Templates {{''__(Required)__''}}:\\ |
!2.2.5 User Templates {{''__(Required❗)__''}}:\\ |
At line 209 changed 2 lines |
__Template Username__: The signed-in user inherits both the settings and the VFS items(as Linked [VFS]). __It must have a value!__\\ |
__Import settings from CrushFTP user__: The signed-in user inherits only the settings from the specified user. __It must have a value!__\\ |
__Template Username__: The signed-in user inherits both the settings and the VFS items(as Linked [VFS]). ⚠️ __It must have a value!__\\ |
__Import settings from CrushFTP user__: The signed-in user inherits only the settings from the specified user. ⚠️ __It must have a value!__\\ |
At line 218 changed one line |
__!!! Important__: If roles are configured and the IdP's user does not match any of the predefined roles, the authentication will be rejected due to the absence of matching roles.\\ |
__⚠️ Important__: If roles are configured and the IdP's user does not match any of the predefined roles, the authentication will be rejected due to the absence of matching roles.\\ |
At line 221 changed one line |
__!!! Important__: Template user must exist in the [User Manager], otherwise, it will have no effect.\\ |
__⚠️ Important__: Template user must exist in the [User Manager], otherwise, it will have no effect.\\ |
At line 230 removed one line |
|
At line 256 changed one line |
!2.2.7 Custom VFS {{''__(Required Under Specific Conditions)__''}}: |
!2.2.7 Custom VFS {{''__(Required Under Specific Conditions❗)__''}}: |
At line 259 changed one line |
__!!! Important:__ If the CrushOIDC user has no assigned VFS, __authentication will be rejected due to the absence of an assigned [VFS]__. CrushOIDC user can inherit VFS configuration from:\\ |
__⚠️ Important:__ If the CrushOIDC user has no assigned VFS, __authentication will be rejected due to the absence of an assigned [VFS]__. CrushOIDC user can inherit VFS configuration from:\\ |
At line 264 changed one line |
__Custom VFS examples:__ Uses the refresh token obtained through OpenID Connect authentication.\\ |
__Custom VFS examples:__ This Custom VFS setup allows access to remote resources using a refresh token obtained through OpenID Connect (OIDC) authentication.\\ |
At line 269 removed one line |
|
At line 271 removed one line |
|
At line 273 removed one line |
\\ |
At line 275 changed 2 lines |
\\ |
__!!! It requires the scope__:\\ |
__⚠️ It requires the scope__:\\ |
At line 279 removed one line |
\\ |
At line 282 changed one line |
__b.) OneDrive__:\\ |
__b.) Google Cloud Storage__:\\ |
\\ |
{{{ |
gstorage://{oidc_client_id}~{oidc_client_secret_decoded}:{oidc_refresh_token}@storage.googleapis.com/ |
}}}\\ |
\\ |
__More info at__: [Google Cloud Storage Integration]\\ |
__⚠️ It requires the scope__:\\ |
{{{ https://www.googleapis.com/auth/devstorage.full_control}}}\\ |
Check the description of : __2.1.3 Authorization related settings__ [Link|https://www.crushftp.com/crush11wiki/Wiki.jsp?page=CrushOIDC#section-CrushOIDC-2.1.3AuthorizationRelatedSettingsRequired] regarding scope.\\ |
[CrushOIDC/oidc_gstorage_settings.png]\\ |
\\ |
__c.) OneDrive__:\\ |
\\ |
At line 284 removed one line |
|
At line 289 removed one line |
\\ |
At line 291 changed 2 lines |
\\ |
__!!!Note__:\\ |
__⚠️ Note__:\\ |
At line 295 removed one line |
\\ |
At line 298 changed one line |
__c.) Sharepoint__:\\ |
__d.) SharePoint__:\\ |
\\ |
At line 300 removed one line |
|
At line 307 removed one line |
\\ |
At line 309 changed 2 lines |
\\ |
__!!!Note__:\\ |
__⚠️ Note__:\\ |
At line 316 changed one line |
__Drive name__: Each SharePoint site has a Document Library where the site-related files are stored. See [SharePoint: Documents and Libraries Description Link||https://support.microsoft.com/en-us/office/what-is-a-document-library-3b5976dd-65cf-4c9e-bf5a-713c10ca2872] Provide its name\\ |
__Drive name__: Each SharePoint site has a Document Library where the site-related files are stored. See [SharePoint: Documents and Libraries Description Link|https://support.microsoft.com/en-us/office/what-is-a-document-library-3b5976dd-65cf-4c9e-bf5a-713c10ca2872] Provide its name\\ |
At line 318 removed one line |
\\ |
At line 320 changed one line |
__d.) DropBox__:\\ |
\\ |
__e.) DropBox__:\\ |
\\ |
At line 322 removed one line |
|
At line 324 removed one line |
|
At line 327 removed one line |
\\ |