# keystoneauth1.loading.identity module

class keystoneauth1.loading.identity.BaseFederationLoader

  Bases: `BaseV3Loader`[`V3FederationPluginT`]

  Base Option handling for federation plugins.

  This class defines options and handling that should be common to the V3 identity federation API. It provides the options expected by the `keystoneauth1.identity.v3.FederationBaseAuth` class.

  __abstractmethods__ = frozenset({})
  __annotations_cache__ = {}
  __doc__ = 'Base Option handling for federation plugins.\n\nThis class defines options and handling that should be common to the V3\nidentity federation API. It provides the options expected by the\n:py:class:`keystoneauth1.identity.v3.FederationBaseAuth` class.\n'
  __firstlineno__ = 137
  __module__ = 'keystoneauth1.loading.identity'
  __orig_bases__ = (keystoneauth1.loading.identity.BaseV3Loader[~V3FederationPluginT],)
  __parameters__ = (~V3FederationPluginT,)
  __static_attributes__ = ()
  _abc_impl = <_abc._abc_data object>
  get_options() → list[Opt]

    Return the list of parameters associated with the auth plugin.

    This list may be used to generate CLI or config arguments.

    Returns:

      A list of Param objects describing available plugin parameters.

    Return type:

      list

class keystoneauth1.loading.identity.BaseGenericLoader

  Bases: `BaseIdentityLoader`[`GenericPluginT`]

  Base Option handling for generic plugins.

  This class defines options and handling that should be common to generic plugins. These plugins target the OpenStack identity service however are designed to be independent of API version. It provides the options expected by the `keystoneauth1.identity.generic.base.BaseGenericPlugin` class.

  __abstractmethods__ = frozenset({})
  __annotations_cache__ = {}
  __doc__ = 'Base Option handling for generic plugins.\n\nThis class defines options and handling that should be common to generic\nplugins. These plugins target the OpenStack identity service however are\ndesigned to be independent of API version. It provides the options expected\nby the :py:class:`keystoneauth1.identity.generic.base.BaseGenericPlugin`\nclass.\n'
  __firstlineno__ = 166
  __module__ = 'keystoneauth1.loading.identity'
  __orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~GenericPluginT],)
  __parameters__ = (~GenericPluginT,)
  __static_attributes__ = ()
  _abc_impl = <_abc._abc_data object>
  get_options() → list[Opt]

    Return the list of parameters associated with the auth plugin.

    This list may be used to generate CLI or config arguments.

    Returns:

      A list of Param objects describing available plugin parameters.

    Return type:

      list

class keystoneauth1.loading.identity.BaseIdentityLoader

  Bases: `BaseLoader`[`PluginT`]

  Base Option handling for identity plugins.

  This class defines options and handling that should be common across all plugins that are developed against the OpenStack identity service. It provides the options expected by the `keystoneauth1.identity.BaseIdentityPlugin` class.

  __abstractmethods__ = frozenset({})
  __annotations_cache__ = {}
  __doc__ = 'Base Option handling for identity plugins.\n\nThis class defines options and handling that should be common across all\nplugins that are developed against the OpenStack identity service. It\nprovides the options expected by the\n:py:class:`keystoneauth1.identity.BaseIdentityPlugin` class.\n'
  __firstlineno__ = 45
  __module__ = 'keystoneauth1.loading.identity'
  __orig_bases__ = (keystoneauth1.loading.base.BaseLoader[~PluginT],)
  __parameters__ = (~PluginT,)
  __static_attributes__ = ()
  _abc_impl = <_abc._abc_data object>
  get_options() → list[Opt]

    Return the list of parameters associated with the auth plugin.

    This list may be used to generate CLI or config arguments.

    Returns:

      A list of Param objects describing available plugin parameters.

    Return type:

      list

class keystoneauth1.loading.identity.BaseV2Loader

  Bases: `BaseIdentityLoader`[`V2PluginT`]

  Base Option handling for identity plugins.

  This class defines options and handling that should be common to the V2 identity API. It provides the options expected by the `keystoneauth1.identity.v2.Auth` class.

  __abstractmethods__ = frozenset({})
  __annotations_cache__ = {}
  __doc__ = 'Base Option handling for identity plugins.\n\nThis class defines options and handling that should be common to the V2\nidentity API. It provides the options expected by the\n:py:class:`keystoneauth1.identity.v2.Auth` class.\n'
  __firstlineno__ = 64
  __module__ = 'keystoneauth1.loading.identity'
  __orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~V2PluginT],)
  __parameters__ = (~V2PluginT,)
  __static_attributes__ = ()
  _abc_impl = <_abc._abc_data object>
  get_options() → list[Opt]

    Return the list of parameters associated with the auth plugin.

    This list may be used to generate CLI or config arguments.

    Returns:

      A list of Param objects describing available plugin parameters.

    Return type:

      list

class keystoneauth1.loading.identity.BaseV3Loader

  Bases: `BaseIdentityLoader`[`V3PluginT`]

  Base Option handling for identity plugins.

  This class defines options and handling that should be common to the V3 identity API. It provides the options expected by the `keystoneauth1.identity.v3.Auth` class.

  __abstractmethods__ = frozenset({})
  __annotations_cache__ = {}
  __doc__ = 'Base Option handling for identity plugins.\n\nThis class defines options and handling that should be common to the V3\nidentity API. It provides the options expected by the\n:py:class:`keystoneauth1.identity.v3.Auth` class.\n'
  __firstlineno__ = 88
  __module__ = 'keystoneauth1.loading.identity'
  __orig_bases__ = (keystoneauth1.loading.identity.BaseIdentityLoader[~V3PluginT],)
  __parameters__ = (~V3PluginT,)
  __static_attributes__ = ()
  _abc_impl = <_abc._abc_data object>
  get_options() → list[Opt]

    Return the list of parameters associated with the auth plugin.

    This list may be used to generate CLI or config arguments.

    Returns:

      A list of Param objects describing available plugin parameters.

    Return type:

      list

  load_from_options(**kwargs: Any) → V3PluginT

    Create a plugin from the arguments retrieved from get_options.

    A client can override this function to do argument validation or to handle differences between the registered options and what is required to create the plugin.

this page last updated: 2026-03-25 21:01:07

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug