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
Ruby agile-developmentangularbcfboardsbug-trackerganttgantt-chartifcissue-trackerjira-alternativekanbanopenprojectproduct-managementproject-managementproject-planningroadmaprubyscrumtimelineworkflows
[#65770] Adjust SCIM provisioning docs.
Pavel Balashou99ba04727281
diff --git a/app/forms/scim_clients/form.rb b/app/forms/scim_clients/form.rbindex 8bad3fb59fc..23db6d44de3 100644--- a/app/forms/scim_clients/form.rb+++ b/app/forms/scim_clients/form.rb@@ -79,7 +79,8 @@ module ScimClientsname: :jwt_sub,label: ScimClient.human_attribute_name(:jwt_sub),required: true,- 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,+ caption: I18n.t("admin.scim_clients.form.jwt_sub_description_html",+ docs_url: ::OpenProject::Static::Links.url_for(:sysadmin_docs, :scim_jwt_authetication_method)).html_safe,input_width: :large)enddiff --git a/app/views/admin/scim_clients/edit.html.erb b/app/views/admin/scim_clients/edit.html.erbindex 552a22b55f5..9f8d922c8fa 100644--- a/app/views/admin/scim_clients/edit.html.erb+++ b/app/views/admin/scim_clients/edit.html.erb@@ -32,7 +32,8 @@ See COPYRIGHT and LICENSE files for more details.<%=render(Primer::OpenProject::PageHeader.new) do |header|header.with_title { @scim_client.name }- header.with_description { t("admin.scim_clients.form.description_html", docs_url: ::OpenProject::Static::Links[:sysadmin_docs][:scim][:href]) }+ header.with_description { t("admin.scim_clients.form.description_html",+ docs_url: ::OpenProject::Static::Links.url_for(:sysadmin_docs, :scim)) }header.with_breadcrumbs([{ href: admin_index_path, text: t(:label_administration) },{ href: admin_settings_authentication_path, text: t(:label_authentication) },diff --git a/app/views/admin/scim_clients/new.html.erb b/app/views/admin/scim_clients/new.html.erbindex 7f7a2986c6e..542906f271b 100644--- a/app/views/admin/scim_clients/new.html.erb+++ b/app/views/admin/scim_clients/new.html.erb@@ -32,7 +32,7 @@ See COPYRIGHT and LICENSE files for more details.<%=render(Primer::OpenProject::PageHeader.new) do |header|header.with_title { t(".title") }- header.with_description { t("admin.scim_clients.form.description_html", docs_url: "#") } # TODO: Deep link into documentation+ header.with_description { t("admin.scim_clients.form.description_html", docs_url: ::OpenProject::Static::Links.url_for(:sysadmin_docs, :scim)) }header.with_breadcrumbs([{ href: admin_index_path, text: t(:label_administration) },{ href: admin_settings_authentication_path, text: t(:label_authentication) },diff --git a/docs/system-admin-guide/authentication/scim/README.md b/docs/system-admin-guide/authentication/scim/README.mdindex b3d739d976f..04fbf556ce0 100644--- a/docs/system-admin-guide/authentication/scim/README.md+++ b/docs/system-admin-guide/authentication/scim/README.md@@ -41,8 +41,6 @@ A configuration form for your SCIM client will open, in which you can adjust the### Step 3. Choose an **Authentication method**.-This is how the SCIM client authenticates at OpenProject. Please ensure that OAuth tokens include the **scim_v2** scope.-There are three *Authentication method* options you can choose from:#### a. **Static access token**@@ -65,7 +63,7 @@ Once created, a SCIM client will appear on the SCIM clients index page.Click on the client name to open the detailed view, edit the information, add revoke or add tokens. You will be able to edit the client information and tokens.-SCIM client tokens can be revoked. To revoke a token click the **Remove** icon at the far right end of the token listing. To add a new token click the **+ Token** button at the bottom of *Tokens* section.+SCIM client tokens can be revoked. To revoke a token click the **Revoke** icon at the far right end of the token listing. To add a new token click the **+ Token** button at the bottom of *Tokens* section.@@ -84,7 +82,7 @@ Here is an example of a configuration form in Keycloak, if you use it with [SCIM#### b. **OAuth 2.0 client credentials**-If in [Step 3](#step-3-choose-an-authentication-method) you selected **OAuth 2.0 client credentials**, after clicking **Create** you will get client credentials of newly created [OpenProject OAuth Application](../oauth-applications/#oauth-applications). These credentials should be entered into the SCIM client configuration on the other end. Then SCIM client is supposed to use provided client credentials to send an access token request to OpenProject.+If in [Step 3](#step-3-choose-an-authentication-method) you selected **OAuth 2.0 client credentials**, after clicking **Create** you will get client credentials of newly created [OpenProject OAuth Application](../oauth-applications/#oauth-applications). These credentials should be entered into the SCIM client configuration on the other end. The SCIM client is supposed to use the provided client credentials to obtain an access token with the `scim_v2` scope from OpenProject and then use the access token in SCIM API requests.@@ -100,6 +98,9 @@ If in [Step 3](#step-3-choose-an-authentication-method) you selected **JWT fromThis 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.+2. The `aud` claim includes OpenProject's Client ID from your OpenID Connect provider configuration.3. The `scope` claim includes `scim_v2`.++This could for example be achieved by performing a client credentials token request towards the identity provider. In the case of Keycloak as an IDP, the sub claim would then equal to the UUID of the service account that's associated to the client obtaining the token.