From 0d94a76d956c0322e9c4607fb5ce824f7653f038 Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Thu, 17 Aug 2017 12:17:39 -0400 Subject: auto-generate docs for v3 identity resources skipped shared v2/v3 identity resources. Change-Id: I9e1fb5dee5506780fd79a0cbfbde059d0ccd1489 --- .../cli/command-objects/identity-provider.rst | 137 ++------------------- 1 file changed, 13 insertions(+), 124 deletions(-) (limited to 'doc/source/cli/command-objects/identity-provider.rst') diff --git a/doc/source/cli/command-objects/identity-provider.rst b/doc/source/cli/command-objects/identity-provider.rst index d96b814a..36c9264a 100644 --- a/doc/source/cli/command-objects/identity-provider.rst +++ b/doc/source/cli/command-objects/identity-provider.rst @@ -2,132 +2,21 @@ identity provider ================= -Identity v3 +An **identity provider** is used by the Identity service's OS-FEDERATION +extension. It is used by **federation protocols** and **mappings**. Applicable +to Identity v3. -`Requires: OS-FEDERATION extension` +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider create -identity provider create ------------------------- +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider delete -Create new identity provider +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider list -.. program:: identity provider create -.. code:: bash +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider set - openstack identity provider create - [--remote-id [...] | --remote-id-file ] - [--description ] - [--domain ] - [--enable | --disable] - - -.. option:: --remote-id - - Remote IDs to associate with the Identity Provider - (repeat option to provide multiple values) - -.. option:: --remote-id-file - - Name of a file that contains many remote IDs to associate with the identity - provider, one per line - -.. option:: --description - - New identity provider description - -.. option:: --domain - - Name or ID of the domain to associate with the identity provider. If not - specified, one will be created automatically - -.. option:: --enable - - Enable the identity provider (default) - -.. option:: --disable - - Disable the identity provider - -.. describe:: - - New identity provider name (must be unique) - -identity provider delete ------------------------- - -Delete identity provider(s) - -.. program:: identity provider delete -.. code:: bash - - openstack identity provider delete - [ ...] - -.. describe:: - - Identity provider(s) to delete - -identity provider list ----------------------- - -List identity providers - -.. program:: identity provider list -.. code:: bash - - openstack identity provider list - -identity provider set ---------------------- - -Set identity provider properties - -.. program:: identity provider set -.. code:: bash - - openstack identity provider set - [--remote-id [...] | --remote-id-file ] - [--description ] - [--enable | --disable] - - -.. option:: --remote-id - - Remote IDs to associate with the Identity Provider - (repeat option to provide multiple values) - -.. option:: --remote-id-file - - Name of a file that contains many remote IDs to associate with the identity - provider, one per line - -.. option:: --description - - Set identity provider description - -.. option:: --enable - - Enable the identity provider - -.. option:: --disable - - Disable the identity provider - -.. describe:: - - Identity provider to modify - -identity provider show ----------------------- - -Display identity provider details - -.. program:: identity provider show -.. code:: bash - - openstack identity provider show - - -.. describe:: - - Identity provider to display +.. autoprogram-cliff:: openstack.identity.v3 + :command: identity provider show -- cgit v1.2.1