Skip to content

Commit 047e4ad

Browse files
committed
saml cleanup
1 parent cb7ef27 commit 047e4ad

File tree

3 files changed

+100
-83
lines changed

3 files changed

+100
-83
lines changed

deploy-manage/users-roles/cloud-enterprise-orchestrator/saml.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ applies:
99

1010
You can configure {{ece}} to delegate authentication of users to a Security Assertion Markup Language (SAML) authentication provider. {{ece}} supports the SAML 2.0 Web Browser Single Sign On Profile only, and this requires the use of a web browser. Due to this, SAML profiles should not be used for standard API clients. The security deployment acts as a SAML 2.0 compliant *service provider*.
1111

12+
:::{{tip}}
13+
This topic describes implementing SAML SSO at the {{ece}} installation level. If you want to control access to a specific deployment, then refer to [SAML authentication](/deploy-manage/users-roles/cluster-or-deployment-auth/saml.md).
14+
:::
15+
1216
To set up SAML authentication, perform the following steps:
1317

1418
1. Specify the [general SAML settings](#ece-saml-general-settings).

deploy-manage/users-roles/cluster-or-deployment-auth/saml-entra.md

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,28 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/cloud/current/ec-securing-clusters-saml-azure.html
44
navigation_title: With Microsoft Entra ID
5+
applies_to:
6+
deployment:
7+
self:
8+
ess:
9+
ece:
10+
eck:
511
---
612
# Set up SAML with Microsoft Entra ID [ec-securing-clusters-saml-azure]
713

8-
This guide provides a walk-through of how to configure Microsoft Entra ID (formerly Azure Active Directory) as an identity provider for SAML single sign-on (SSO) authentication, used for accessing Kibana in Elasticsearch Service.
14+
This guide provides a walk-through of how to configure Microsoft Entra ID, formerly known as Azure Active Directory, as an identity provider for SAML single sign-on (SSO) authentication, used for accessing {{kib}} in {{ech}}.
915

10-
For more information about SAML configuration, you can also refer to:
16+
For more information about SAML configuration, refer to:
1117

12-
* [Secure your clusters with SAML](../../../deploy-manage/users-roles/cluster-or-deployment-auth/saml.md)
18+
* [Secure your clusters with SAML](/deploy-manage/users-roles/cluster-or-deployment-auth/saml.md)
1319
* [Single Sign-On SAML protocol](https://docs.microsoft.com/en-us/azure/active-directory/develop/single-sign-on-saml-protocol)
1420

1521

16-
## Configure SAML with Azure AD to access Kibana [ec-securing-clusters-saml-azure-kibana]
22+
## Configure SAML with Microsoft Entra ID to access {{kib}} [ec-securing-clusters-saml-azure-kibana]
1723

18-
Follow these steps to configure SAML with Microsoft Entra ID as an identity provider to access Kibana.
24+
Follow these steps to configure SAML with Microsoft Entra ID as an identity provider to access {{kib}}.
1925

20-
1. Configure the Azure Identity Provider:
26+
1. Configure the Entra Identity Provider:
2127

2228
1. Log in to the [Azure Portal](https://portal.azure.com/) and navigate to **Entra** (formerly Azure Active Directory).
2329
2. Click **Enterprise applications** and then **New application** to register a new application.
@@ -27,41 +33,41 @@ Follow these steps to configure SAML with Microsoft Entra ID as an identity prov
2733
:alt: The Azure Create your own application flyout
2834
:::
2935

30-
4. Navigate to the new application, click **Users and groups**, and add all necessary users and groups. Only the users and groups that you add here will have SSO access to the Elastic stack.
36+
4. Navigate to the new application, click **Users and groups**, and add all necessary users and groups. Only the users and groups that you add here will have SSO access to the {{stack}}.
3137

3238
:::{image} ../../../images/cloud-ec-saml-azuread-users-and-groups.png
33-
:alt: The Azure User and groups page
39+
:alt: The Entra User and groups page
3440
:::
3541

3642
5. Navigate to **Single sign-on** and edit the basic SAML configuration, adding the following information:
3743

38-
* `Identifier (Entity ID)` - a string that uniquely identifies a SAML service provider. We recommend using your Kibana URL, but you can use any identifier.
44+
* `Identifier (Entity ID)` - a string that uniquely identifies a SAML service provider. We recommend using your {{kib}} URL, but you can use any identifier.
3945

4046
For example, `https://saml-azure.kb.northeurope.azure.elastic-cloud.com:443`.
4147

42-
* `Reply URL` - This is the Kibana URL with `/api/security/saml/callback` appended.
48+
* `Reply URL` - This is the {{kib}} URL with `/api/security/saml/callback` appended.
4349

4450
For example, `https://saml-azure.kb.northeurope.azure.elastic-cloud.com:443/api/security/saml/callback`.
4551

46-
* `Logout URL` - This is the Kibana URL with `/logout` appended.
52+
* `Logout URL` - This is the {{kib}} URL with `/logout` appended.
4753

4854
For example, `https://saml-azure.kb.northeurope.azure.elastic-cloud.com:443/logout`.
4955

5056
:::{image} ../../../images/cloud-ec-saml-azuread-kibana-config.png
51-
:alt: The Azure SAML configuration page with Kibana settings
57+
:alt: The Entra SAML configuration page with {{kib}} settings
5258
:::
5359

54-
6. Navigate to **SAML-based Single sign-on**, open the **User Attributes & Claims** configuration, and update the fields to suit your needs. These settings control what information from Azure AD will be made available to the Elastic stack during SSO. This information can be used to identify a user in the Elastic stack and/or to assign different roles to users in the Elastic stack. We suggest that you configure a proper value for the `Unique User Identifier (Name ID)` claim that identifies the user uniquely and is not prone to changes.
60+
6. Navigate to **SAML-based Single sign-on**, open the **User Attributes & Claims** configuration, and update the fields to suit your needs. These settings control what information from will be made available to the {{stack}} during SSO. This information can be used to identify a user in the {{stack}} and/or to assign different roles to users in the {{stack}}. We suggest that you configure a proper value for the `Unique User Identifier (Name ID)` claim that identifies the user uniquely and is not prone to changes.
5561

5662
:::{image} ../../../images/cloud-ec-saml-azuread-user-attributes.png
57-
:alt: The Azure User Attributes & Claims page
63+
:alt: The Entra ID User Attributes & Claims page
5864
:::
5965

60-
7. From the SAML configuration page in Azure, make a note of the `App Federation Metadata URL`.
66+
7. From the SAML configuration page, make a note of the `App Federation Metadata URL`.
6167

62-
2. Configure Elasticsearch and Kibana for SAML:
68+
2. Configure {{es}} and {{kib}} for SAML:
6369

64-
1. [Update your Elasticsearch user settings](../../../deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) with the following configuration:
70+
1. [Update your {{es}} user settings](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) with the following configuration:
6571

6672
```sh
6773
xpack.security.authc.realms.saml.kibana-realm:
@@ -79,21 +85,21 @@ Follow these steps to configure SAML with Microsoft Entra ID as an identity prov
7985

8086
* `<Application_ID>` is your Application ID, available in the application details in Azure.
8187
* `<Tenant_ID>` is your Tenant ID, available in the tenant overview page in Azure.
82-
* `<Kibana_Endpoint_URL>` is your Kibana endpoint, available from the Elasticsearch Service console. Ensure this is the same value that you set for `Identifier (Entity ID)` in the earlier Azure AD configuration step.
88+
* `<Kibana_Endpoint_URL>` is your {{kib}} endpoint, available from the {{ech}} console. Ensure this is the same value that you set for `Identifier (Entity ID)` in the earlier Microsoft Entra ID configuration step.
8389

84-
Note that for `idp.metadata.path` we’ve shown the format to construct the URL, but this should be identical to the `App Federation Metadata URL` setting that you made a note of in the previous step.
90+
For `idp.metadata.path`, we’ve shown the format to construct the URL. This value should be identical to the `App Federation Metadata URL` setting that you made a note of in the previous step.
8591

86-
Remember to add this configuration for each node type in your [user settings](../../../deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) if you use several node types based on your deployment architecture (Dedicated Master, High IO, and/or High Storage).
92+
If you're using {{ece}} or {{ech}}, and you're using machine learning or a deployment with hot-warm architecture, you must include this configuration in the user settings section for each node type.
8793

88-
2. Next, configure Kibana to enable SAML authentication:
89-
1. [Update your Kibana user settings](../../../deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) with the following configuration:
94+
2. Next, configure {{kib}} to enable SAML authentication:
95+
1. [Update your {{kib}} user settings](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) with the following configuration:
9096

9197
```yaml
9298
xpack.security.authc.providers:
9399
saml.kibana-realm:
94100
order: 0
95101
realm: kibana-realm
96-
description: "Log in with Azure AD"
102+
description: "Log in with Microsoft Entra ID"
97103
```
98104

99105
The configuration values used in the example above are:
@@ -102,7 +108,7 @@ Follow these steps to configure SAML with Microsoft Entra ID as an identity prov
102108
: Add `saml` provider to instruct {{kib}} to use SAML SSO as the authentication method.
103109

104110
`xpack.security.authc.providers.saml.<provider-name>.realm`
105-
: Set this to the name of the SAML realm that you have used in your [Elasticsearch realm configuration](../../../deploy-manage/users-roles/cluster-or-deployment-auth/saml.md#saml-create-realm). For this example, use the realm name that you configured in the previous step: `kibana-realm`.
111+
: Set this to the name of the SAML realm that you have used in your [{{es}} realm configuration](/deploy-manage/users-roles/cluster-or-deployment-auth/saml.md#saml-create-realm). For this example, use the realm name that you configured in the previous step: `kibana-realm`.
106112

107113
2. Create a role mapping.
108114

@@ -133,7 +139,7 @@ Follow these steps to configure SAML with Microsoft Entra ID as an identity prov
133139
}
134140
```
135141
136-
For more information, refer to [Configure role mapping](../../../deploy-manage/users-roles/cluster-or-deployment-auth/saml.md#saml-role-mapping) in the Elasticsearch SAML documentation.
142+
For more information, refer to [Configure role mapping](/deploy-manage/users-roles/cluster-or-deployment-auth/saml.md#saml-role-mapping) in the {{es}} SAML documentation.
137143
138144
139-
You should now have successfully configured SSO access to Kibana with Azure AD as the identity provider.
145+
You should now have successfully configured SSO access to {{kib}} with Microsoft Entra ID as the identity provider.

0 commit comments

Comments
 (0)