You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: deploy-manage/users-roles/cloud-enterprise-orchestrator/saml.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,10 @@ applies:
9
9
10
10
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*.
11
11
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
+
12
16
To set up SAML authentication, perform the following steps:
13
17
14
18
1. Specify the [general SAML settings](#ece-saml-general-settings).
# Set up SAML with Microsoft Entra ID [ec-securing-clusters-saml-azure]
7
13
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}}.
9
15
10
-
For more information about SAML configuration, you can also refer to:
16
+
For more information about SAML configuration, refer to:
11
17
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)
## 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]
17
23
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}}.
19
25
20
-
1. Configure the Azure Identity Provider:
26
+
1. Configure the Entra Identity Provider:
21
27
22
28
1. Log in to the [Azure Portal](https://portal.azure.com/) and navigate to **Entra** (formerly Azure Active Directory).
23
29
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
27
33
:alt: The Azure Create your own application flyout
28
34
:::
29
35
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}}.
5. Navigate to **Single sign-on** and edit the basic SAML configuration, adding the following information:
37
43
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.
39
45
40
46
For example, `https://saml-azure.kb.northeurope.azure.elastic-cloud.com:443`.
41
47
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.
43
49
44
50
For example, `https://saml-azure.kb.northeurope.azure.elastic-cloud.com:443/api/security/saml/callback`.
45
51
46
-
*`Logout URL` - This is the Kibana URL with `/logout` appended.
52
+
*`Logout URL` - This is the {{kib}} URL with `/logout` appended.
47
53
48
54
For example, `https://saml-azure.kb.northeurope.azure.elastic-cloud.com:443/logout`.
:alt: The Azure SAML configuration page with Kibana settings
57
+
:alt: The Entra SAML configuration page with {{kib}} settings
52
58
:::
53
59
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.
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`.
61
67
62
-
2. Configure Elasticsearch and Kibana for SAML:
68
+
2. Configure {{es}} and {{kib}} for SAML:
63
69
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:
65
71
66
72
```sh
67
73
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
79
85
80
86
*`<Application_ID>` is your Application ID, available in the application details in Azure.
81
87
*`<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 setfor`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 setfor`Identifier (Entity ID)`in the earlier Microsoft Entra ID configuration step.
83
89
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 ofin 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.
85
91
86
-
Remember to add this configuration foreach node typein 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.
87
93
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:
90
96
91
97
```yaml
92
98
xpack.security.authc.providers:
93
99
saml.kibana-realm:
94
100
order: 0
95
101
realm: kibana-realm
96
-
description: "Log in with Azure AD"
102
+
description: "Log in with Microsoft Entra ID"
97
103
```
98
104
99
105
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
102
108
: Add `saml` provider to instruct {{kib}} to use SAML SSO as the authentication method.
: 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`.
106
112
107
113
2. Create a role mapping.
108
114
@@ -133,7 +139,7 @@ Follow these steps to configure SAML with Microsoft Entra ID as an identity prov
133
139
}
134
140
```
135
141
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.
137
143
138
144
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