From d688cb58a3a21ce5fbb5edf4e4feaae9998cb21c Mon Sep 17 00:00:00 2001 From: pedro Date: Mon, 4 Nov 2019 19:14:23 -0300 Subject: 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 --- doc/source/cli/authentication.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc/source/cli/authentication.rst') 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. ` -- cgit v1.2.1