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
OIDC clarifications and tip for Azure added (elastic#3498)
A user shared some interesting suggestions in
elastic/platform-docs-team#553 (internal
issue)
I've addressed two of them in this PR:
- Added extra details of the usefulness of `claims.name` and
`claims.mail`.
- Added a tip for companies with large group memberships in Azure.
Closeselastic/platform-docs-team#553
(internal issue)
---------
Co-authored-by: shainaraskas <[email protected]>
Copy file name to clipboardExpand all lines: deploy-manage/users-roles/cluster-or-deployment-auth/oidc-examples.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,6 +99,15 @@ For more information about OpenID connect in Azure, refer to [Azure OAuth 2.0 an
99
99
*`KIBANA_ENDPOINT_URL` is your {{kib}} endpoint.
100
100
*`YOUR_DOMAIN` and `TLD`in the `claim_patterns.principal` regular expression are your organization email domain and top level domain.
101
101
102
+
:::{admonition} For organizations with many group memberships
103
+
If you configure [`claims.groups`](/deploy-manage/users-roles/cluster-or-deployment-auth/openid-connect.md#oidc-user-properties) to read the list of Azure AD groups from the ID token, be aware that users who belong to many groups may exceed Azure AD’s token size limit. In that case, the `groups` claim will be omitted.
104
+
105
+
To avoid this, enable the **Groups assigned to the application** option in Azure Entra (**App registrations > Token configuration > Edit groups claim**). This setting limits the `groups` claim to only those assigned to the application.
106
+
107
+
**Alternative:** If you can’t restrict groups to app-assigned ones, use the [Microsoft Graph Authz plugin for Elasticsearch](elasticsearch://reference/elasticsearch-plugins/ms-graph-authz.md). It looks up group memberships through Microsoft Graph during authorization, so it continues to work even when the `groups` claim is omitted due to overage.
108
+
109
+
Refer to [Group overages](https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles#group-overages) in the Microsoft Security documentation for more information.
110
+
:::
102
111
103
112
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.
Copy file name to clipboardExpand all lines: deploy-manage/users-roles/cluster-or-deployment-auth/openid-connect.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -254,10 +254,10 @@ groups
254
254
: *(Recommended)* If you want to use your OP’s concept of groups or roles as the basis for a user’s {{es}} privileges, you should map them with this property. The `groups` are passed directly to your [role mapping rules](/deploy-manage/users-roles/cluster-or-deployment-auth/openid-connect.md#oidc-role-mappings).
255
255
256
256
name
257
-
: *(Optional)* The user’s full name.
257
+
: *(Optional)* The user’s full name. It will be used in {{kib}}'s profile page to display user details. Use the payload key of your ID token that fits best here.
258
258
259
259
mail
260
-
: *(Optional)* The user’s email address.
260
+
: *(Optional)* The user’s email address. It will be used in {{kib}}'s profile page to display user details. Use the payload key of your ID token that fits best here.
261
261
262
262
dn
263
263
: *(Optional)* The user’s X.500 Distinguished Name.
Copy file name to clipboardExpand all lines: deploy-manage/users-roles/cluster-or-deployment-auth/saml-entra.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,9 +89,19 @@ Follow these steps to configure SAML with Microsoft Entra ID as an identity prov
89
89
*`<Tenant_ID>` is your Tenant ID, available in the tenant overview page in Azure.
90
90
*`<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.
91
91
92
-
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.
92
+
* 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.
93
93
94
-
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.
94
+
:::{admonition} For organizations with many group memberships
95
+
If you configure [`attributes.groups`](/deploy-manage/users-roles/cluster-or-deployment-auth/saml.md#saml-es-user-properties) to read the list of Azure AD groups from the SAML assertion, be aware that users who belong to many groups may exceed Azure AD’s size limit for SAML tokens. In that case, the `groups` attribute will be omitted.
96
+
97
+
To avoid this, enable the **Groups assigned to the application** option in Azure Entra (**App registrations > Token configuration > Edit groups claim**). This setting limits the `groups` attribute in the SAML assertion to only those groups assigned to the application.
98
+
99
+
**Alternative:** If you can’t restrict groups to app-assigned ones, use the [Microsoft Graph Authz plugin for Elasticsearch](elasticsearch://reference/elasticsearch-plugins/ms-graph-authz.md). It looks up group memberships through Microsoft Graph during authorization, so it continues to work even when the `groups` attribute is omitted due to overage.
100
+
101
+
Refer to [Group overages](https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles#group-overages) in the Microsoft Security documentation for more information.
102
+
:::
103
+
104
+
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.
95
105
96
106
2. Next, configure {{kib}} to enable SAML authentication:
97
107
1. [Update your {{kib}} user settings](/deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) with the following configuration:
0 commit comments