[DOCS] Add examples for security user profile and SAML APIs

[lcawl]

Relates to #2482

This PR adds more examples and descriptions derived from https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api.html, in particular for the security user profile and SAML APIs.

[github-actions]

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
security.activate_user_profile	🟢	9/9	9/9
security.authenticate	🟢	30/30	30/30
security.bulk_delete_role	🟢	1/1	1/1
security.bulk_put_role	🟢	1/1	1/1
security.bulk_update_api_keys	🟢	4/4	4/4
security.change_password	🟢	9/9	9/9
security.clear_api_key_cache	🟢	13/13	13/13
security.clear_cached_privileges	🟢	3/3	3/3
security.clear_cached_realms	🟢	1/1	1/1
security.clear_cached_roles	🟢	2/2	2/2
security.clear_cached_service_tokens	🟢	4/4	4/4
security.create_api_key	🟢	68/68	59/59
security.create_cross_cluster_api_key	🟢	3/3	3/3
security.create_service_token	🟢	3/3	3/3
security.delegate_pki	⚪	Missing test	Missing test
security.delete_privileges	🟢	6/6	6/6
security.delete_role_mapping	🟢	9/9	9/9
security.delete_role	🟢	8/8	8/8
security.delete_service_token	⚪	Missing test	Missing test
security.delete_user	🟢	9/9	9/9
security.disable_user_profile	🟢	1/1	1/1
security.disable_user	🟢	3/3	3/3
security.enable_user_profile	🟢	1/1	1/1
security.enable_user	🟢	4/4	4/4
security.enroll_kibana	⚪	Missing test	Missing test
security.enroll_node	⚪	Missing test	Missing test
security.get_api_key	🟢	26/26	26/26
security.get_builtin_privileges	🟢	1/1	1/1
security.get_privileges	🟢	12/12	12/12
security.get_role_mapping	🔴	18/18	10/18
security.get_role	🔴	24/24	22/24
security.get_service_accounts	⚪	Missing test	Missing test
security.get_service_credentials	🟢	1/1	1/1
security.get_settings	🟢	3/3	3/3
security.get_token	🟢	25/25	24/24
security.get_user_privileges	🔴	8/8	7/8
security.get_user_profile	🟢	8/8	8/8
security.get_user	🟢	25/25	25/25
security.grant_api_key	🟢	7/7	7/7
security.has_privileges_user_profile	🟢	3/3	3/3
security.has_privileges	🟢	24/24	24/24
security.invalidate_api_key	🟢	12/12	12/12
security.invalidate_token	🟢	11/11	11/11
security.oidc_authenticate	⚪	Missing test	Missing test
security.oidc_logout	⚪	Missing test	Missing test
security.oidc_prepare_authentication	⚪	Missing test	Missing test
security.put_privileges	🟢	10/10	10/10
security.put_role_mapping	🔴	2/11	11/11
security.put_role	🟢	39/39	38/38
security.put_user	🟢	48/48	47/47
security.query_api_keys	🟢	14/14	14/14
security.query_role	🟢	2/2	2/2
security.query_user	🟢	4/4	4/4
security.saml_authenticate	⚪	Missing test	Missing test
security.saml_complete_logout	⚪	Missing test	Missing test
security.saml_invalidate	⚪	Missing test	Missing test
security.saml_logout	⚪	Missing test	Missing test
security.saml_prepare_authentication	⚪	Missing test	Missing test
security.saml_service_provider_metadata	⚪	Missing test	Missing test
security.suggest_user_profiles	🟢	1/1	1/1
security.update_api_key	🟢	5/5	5/5
security.update_cross_cluster_api_key	🟢	2/2	2/2
security.update_settings	🔴	1/2	2/2
security.update_user_profile_data	🟢	1/1	1/1

You can validate these APIs yourself by using the make validate target.

[szabosteve]

LGTM!

[github-actions]

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
security.activate_user_profile	🟢	9/9	9/9
security.authenticate	🟢	30/30	30/30
security.bulk_delete_role	🟢	1/1	1/1
security.bulk_put_role	🟢	1/1	1/1
security.bulk_update_api_keys	🟢	4/4	4/4
security.change_password	🟢	9/9	9/9
security.clear_api_key_cache	🟢	13/13	13/13
security.clear_cached_privileges	🟢	3/3	3/3
security.clear_cached_realms	🟢	1/1	1/1
security.clear_cached_roles	🟢	2/2	2/2
security.clear_cached_service_tokens	🟢	4/4	4/4
security.create_api_key	🟢	68/68	59/59
security.create_cross_cluster_api_key	🟢	3/3	3/3
security.create_service_token	🟢	3/3	3/3
security.delegate_pki	⚪	Missing test	Missing test
security.delete_privileges	🟢	6/6	6/6
security.delete_role_mapping	🟢	9/9	9/9
security.delete_role	🟢	8/8	8/8
security.delete_service_token	⚪	Missing test	Missing test
security.delete_user	🟢	9/9	9/9
security.disable_user_profile	🟢	1/1	1/1
security.disable_user	🟢	3/3	3/3
security.enable_user_profile	🟢	1/1	1/1
security.enable_user	🟢	4/4	4/4
security.enroll_kibana	⚪	Missing test	Missing test
security.enroll_node	⚪	Missing test	Missing test
security.get_api_key	🟢	26/26	26/26
security.get_builtin_privileges	🟢	1/1	1/1
security.get_privileges	🟢	12/12	12/12
security.get_role_mapping	🔴	18/18	10/18
security.get_role	🔴	24/24	22/24
security.get_service_accounts	⚪	Missing test	Missing test
security.get_service_credentials	🟢	1/1	1/1
security.get_settings	🟢	3/3	3/3
security.get_token	🟢	25/25	24/24
security.get_user_privileges	🔴	8/8	7/8
security.get_user_profile	🟢	8/8	8/8
security.get_user	🟢	25/25	25/25
security.grant_api_key	🟢	7/7	7/7
security.has_privileges_user_profile	🟢	3/3	3/3
security.has_privileges	🟢	24/24	24/24
security.invalidate_api_key	🟢	12/12	12/12
security.invalidate_token	🟢	11/11	11/11
security.oidc_authenticate	⚪	Missing test	Missing test
security.oidc_logout	⚪	Missing test	Missing test
security.oidc_prepare_authentication	⚪	Missing test	Missing test
security.put_privileges	🟢	10/10	10/10
security.put_role_mapping	🔴	2/11	11/11
security.put_role	🟢	39/39	38/38
security.put_user	🟢	48/48	47/47
security.query_api_keys	🟢	14/14	14/14
security.query_role	🟢	2/2	2/2
security.query_user	🟢	4/4	4/4
security.saml_authenticate	⚪	Missing test	Missing test
security.saml_complete_logout	⚪	Missing test	Missing test
security.saml_invalidate	⚪	Missing test	Missing test
security.saml_logout	⚪	Missing test	Missing test
security.saml_prepare_authentication	⚪	Missing test	Missing test
security.saml_service_provider_metadata	⚪	Missing test	Missing test
security.suggest_user_profiles	🟢	1/1	1/1
security.update_api_key	🟢	5/5	5/5
security.update_cross_cluster_api_key	🟢	2/2	2/2
security.update_settings	🔴	1/2	2/2
security.update_user_profile_data	🟢	1/1	1/1

You can validate these APIs yourself by using the make validate target.

[github-actions]

The backport to 8.17 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.17 8.17
# Navigate to the new working tree
cd .worktrees/backport-8.17
# Create a new branch
git switch --create backport-3520-to-8.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 72c9fef8f89e1416cb1eae413e9d050f2f2f1e59
# Push it to GitHub
git push --set-upstream origin backport-3520-to-8.17
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.17

Then, create a pull request where the base branch is 8.17 and the compare/head branch is backport-3520-to-8.17.

[lcawl]

💚 All backports created successfully

Status	Branch	Result
✅	8.17

Questions ?

Please refer to the Backport tool documentation