keystoneauth1.loading.identity module¶

class keystoneauth1.loading.identity.BaseFederationLoader¶

Bases: keystoneauth1.loading.identity.BaseV3Loader

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.

get_options()¶

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: keystoneauth1.loading.identity.BaseIdentityLoader

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.v3.BaseGenericPlugin class.

get_options()¶

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: keystoneauth1.loading.base.BaseLoader

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.

get_options()¶

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: keystoneauth1.loading.identity.BaseIdentityLoader

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.

get_options()¶

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: keystoneauth1.loading.identity.BaseIdentityLoader

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.

get_options()¶

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)¶

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.