Skip to content

Commit

Permalink
Update security documentation around username resolution (#5580)
Browse files Browse the repository at this point in the history
* readd auth token doc

Signed-off-by: Stephen Crawford <[email protected]>

* Add docs

Signed-off-by: Stephen Crawford <[email protected]>

* Remove extra file

Signed-off-by: Stephen Crawford <[email protected]>

* remove please

Signed-off-by: Stephen Crawford <[email protected]>

* Update _security/configuration/tls.md

Signed-off-by: Stephen Crawford <[email protected]>

* Update

Signed-off-by: Stephen Crawford <[email protected]>

* split pr

Signed-off-by: Stephen Crawford <[email protected]>

---------

Signed-off-by: Stephen Crawford <[email protected]>
Signed-off-by: Stephen Crawford <[email protected]>
(cherry picked from commit 5f12318)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] committed Nov 13, 2023
1 parent af7cf91 commit 32b7e39
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion _security/authentication-backends/authc-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Authentication backend configurations determine the method or methods you use fo

1. To identify a user who wants to access the cluster, the Security plugin needs the user's credentials.

These credentials differ depending on how you've configured the plugin. For example, if you use basic authentication, the credentials are a username and password. If you use a JSON web token, the credentials (username and roles) are stored within the token itself. If you use TLS certificates, the credentials are the distinguished name (DN) of the certificate. No matter which backend you use, these credentials are included in the request for authentication.
These credentials differ depending on how you've configured the plugin. For example, if you use basic authentication, the credentials are a username and password. If you use a JSON web token, the credentials (username and roles) are stored within the token itself. If you use TLS certificates, the credentials are the distinguished name (DN) of the certificate. No matter which backend you use, these credentials are included in the request for authentication. Note, the Security plugin does not distinguish between identity providers when handling standard role mappings. As a result, only backend roles will differ between two users with the same name coming from two different identity providers.

2. The Security plugin authenticates a request against a backend configured for an authentication provider. Some examples of authentication providers used with OpenSearch include Basic Auth (which uses the internal user database), LDAP/Active Directory, JSON web tokens, SAML, or another authentication protocol.

Expand Down

0 comments on commit 32b7e39

Please sign in to comment.