diff options
| author | pedro <phpm13@gmail.com> | 2019-11-04 19:14:23 -0300 |
|---|---|---|
| committer | pedro <phpm13@gmail.com> | 2020-12-02 08:42:39 -0300 |
| commit | d688cb58a3a21ce5fbb5edf4e4feaae9998cb21c (patch) | |
| tree | afb0f2931f1365e437b278caf40a6e62ddb0d9d4 /doc/source/cli/authentication.rst | |
| parent | ea358057f8c89adbf3d077f1f31036baf1710c59 (diff) | |
| download | python-openstackclient-d688cb58a3a21ce5fbb5edf4e4feaae9998cb21c.tar.gz | |
Add documentation about login with federation
The documentation presents the parameters necessary
to authenticate via federation (using password) and do
a brief description of each parameter used in the process.
Change-Id: Iae3b6d0b56ebd2bbbb94f9f3637b5086e75559a7
Diffstat (limited to 'doc/source/cli/authentication.rst')
| -rw-r--r-- | doc/source/cli/authentication.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/source/cli/authentication.rst b/doc/source/cli/authentication.rst index 3b404bce..2e9148c3 100644 --- a/doc/source/cli/authentication.rst +++ b/doc/source/cli/authentication.rst @@ -133,3 +133,17 @@ Thus, a minimal set of environment variables would be: $ export OS_USERNAME=admin $ export OS_PASSWORD=secret $ export OS_PROJECT_NAME=admin + +Federated users support +----------------------- + +The OpenStackClient also allows the use of Federated users to log in. +It enables one to use the identity providers credentials such as Google or +Facebook to log in the OpenStackClient instead of using the Keystone +credentials. + +This is useful in a Federated environment where one credential give access +to many applications/services that the Federation supports. To check how to +configure the OpenStackClient to allow Federated users to log in, please check +the +:ref:`Authentication using federation. <manpage>` |