Skip to content

Commit

Permalink
Merge pull request ceph#25943 from rhcs-dashboard/update-sso-doc
Browse files Browse the repository at this point in the history
mgr/dashboard: updated SSO documentation

Reviewed-by: Ricardo Marques <[email protected]>
  • Loading branch information
LenzGr authored Jan 14, 2019
2 parents c70a3d8 + 2ac3dc1 commit 3623aed
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions doc/mgr/dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -340,12 +340,14 @@ To configure SSO on Ceph Dashboard, you should use the following command::

Parameters:

- **<ceph_dashboard_base_url>**: Base URL where Ceph Dashboard is accessible (e.g., `https://cephdashboard.local`)
- **<idp_metadata>**: URL, file path or content of the IdP metadata XML (e.g., `https://myidp/metadata`)
- **<idp_username_attribute>** *(optional)*: Attribute that should be used to get the username from the authentication response. Defaults to `uid`.
- **<idp_entity_id>** *(optional)*: Use this when more than one entity id exists on the IdP metadata.
- **<sp_x_509_cert> / <sp_private_key>** *(optional)*: File path or content of the certificate that should be used by Ceph Dashboard (Service Provider) for signing and encryption.
* **<ceph_dashboard_base_url>**: Base URL where Ceph Dashboard is accessible (e.g., `https://cephdashboard.local`)
* **<idp_metadata>**: URL, file path or content of the IdP metadata XML (e.g., `https://myidp/metadata`)
* **<idp_username_attribute>** *(optional)*: Attribute that should be used to get the username from the authentication response. Defaults to `uid`.
* **<idp_entity_id>** *(optional)*: Use this when more than one entity id exists on the IdP metadata.
* **<sp_x_509_cert> / <sp_private_key>** *(optional)*: File path or content of the certificate that should be used by Ceph Dashboard (Service Provider) for signing and encryption.

.. note::
The issuer value of SAML requests will follow this pattern: **<ceph_dashboard_base_url>**/auth/saml2/metadata

To display the current SAML 2.0 configuration, use the following command::

Expand Down

0 comments on commit 3623aed

Please sign in to comment.