Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

[#65770] Update SCIM client JWT base auth docs.

Pavel Balashou40b9e6e6a54e
diff --git a/app/forms/scim_clients/form.rb b/app/forms/scim_clients/form.rb
index f6fb73e15da..8bad3fb59fc 100644
--- a/app/forms/scim_clients/form.rb
+++ b/app/forms/scim_clients/form.rb
@@ -79,7 +79,7 @@ module ScimClients
name: :jwt_sub,
label: ScimClient.human_attribute_name(:jwt_sub),
required: true,
- caption: I18n.t("admin.scim_clients.form.jwt_sub_description_html", docs_url: "#").html_safe, # TODO: correct docs url
+ caption: I18n.t("admin.scim_clients.form.jwt_sub_description_html", docs_url: ::OpenProject::Static::Links[:sysadmin_docs][:scim_jwt_authetication_method][:href]).html_safe,
input_width: :large
)
end
diff --git a/config/static_links.yml b/config/static_links.yml
index 2f0fe048294..11f3686fc78 100644
--- a/config/static_links.yml
+++ b/config/static_links.yml
@@ -162,6 +162,8 @@ sysadmin_docs:
href: https://www.openproject.org/docs/system-admin-guide/authentication/saml/
scim:
href: https://www.openproject.org/docs/system-admin-guide/authentication/scim/
+ scim_jwt_authetication_method:
+ href: https://www.openproject.org/docs/system-admin-guide/authentication/scim/#c-jwt-from-identity-provider
text_formatting:
href: https://www.openproject.org/docs/user-guide/wysiwyg/
label: :setting_text_formatting
diff --git a/docs/system-admin-guide/authentication/scim/README.md b/docs/system-admin-guide/authentication/scim/README.md
index eaaf2b41315..26833d8c42f 100644
--- a/docs/system-admin-guide/authentication/scim/README.md
+++ b/docs/system-admin-guide/authentication/scim/README.md
@@ -94,3 +94,9 @@ Once you click **Create**, client credentials (client ID and secret) will be gen
If in [Step 3](#step-3-choose-an-authentication-method) you selected **JWT from identity provider**, you will have to specify **Subject claim** contained in the authentication JWT.
![Add SCIM client. Creation form. JWT from identity provider. Specify Subject claim.](add_scim_9.png)
+
+This authentication method is intended exclusively for use with OpenID Connect setups.
+The SCIM client must be able to obtain a JWT from the OpenID Connect provider (e.g., Keycloak) that meets all of the following conditions:
+1. The `sub` claim contains the value specified in the Subject Claim configuration.
+2. The `aud` claim includes the Client ID from your OpenID Connect provider configuration.
+3. The `scope` claim includes `scim_v2`.