Skip to content

Commit

Permalink
docs: Document scim display name attribute (#8606)
Browse files Browse the repository at this point in the history
  • Loading branch information
tara-det-ai authored Jan 3, 2024
1 parent 134c2e1 commit 86aab14
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 5 deletions.
11 changes: 11 additions & 0 deletions docs/manage/security/scim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,14 @@ To configure Determined for this integration, update the :ref:`master configurat
type: basic
username: "determined"
password: "password"
******************************************
Automatically Update Users' Display Name
******************************************

You can automatically assign ``display_name`` without having to manually modify the attribute. To do
this:

- Pass the claim name as ``display_name``

This is already the default behavior for Okta.
12 changes: 7 additions & 5 deletions docs/manage/users-remote.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
Managing Remote Users
#######################

Determined lets you manage users and user provisioning remotely. Remote user provisioning lets you
include and synchronize any information about the user stored in your IdP such as their username,
display name, and groups. Once configured, you can manage remote users without having to manually
modify the users or update them via SCIM. Each time the remote user accesses Determined, their
information is synchronized.
When using OIDC or SAML as your authentication protocol you can configure Determined to remote
provision and manage your users.

Remote user provisioning lets you include and synchronize any information about the user stored in
your IdP such as their username, display name, and groups. Once configured, you can manage remote
users without having to manually modify the users or update them via SCIM. Each time the remote user
accesses Determined, their information is synchronized.

.. include:: ../_shared/attn-enterprise-edition.txt

Expand Down
20 changes: 20 additions & 0 deletions docs/reference/deploy/master-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1545,6 +1545,26 @@ Security-related configuration settings.
Applies only to Determined Enterprise Edition. Specifies whether the SCIM service is enabled and the
credentials for clients to use it.

See also: :ref:`remote user <remote-users>` management.

For example:

.. code:: yaml
scim:
enabled: true
auth:
type: basic
username: determined
password: password
saml:
enabled: true
provider: "Okta"
idp_recipient_url: "http://xx.xxx.xxx.xx:8080/saml/sso"
idp_sso_url: "https://xxx/xxx/xxx0000/sso/saml/"
idp_sso_descriptor_url: "http://www.okta.com/xxx000"
idp_cert_path: "okta.cert"
``enabled``
===========

Expand Down

0 comments on commit 86aab14

Please sign in to comment.