keystoneauth1.identity.v3.receipt module

class keystoneauth1.identity.v3.receipt.ReceiptMethod(**kwargs: object)

Bases: AuthMethod

Construct an Auth plugin to continue authentication with a receipt.

Parameters:

receipt (string) – Receipt for authentication.

__abstractmethods__ = frozenset({})
__annotations__ = {'_method_parameters': 'ty.List[str]', 'receipt': <class 'str'>}
__doc__ = 'Construct an Auth plugin to continue authentication with a receipt.\n\n    :param string receipt: Receipt for authentication.\n    '
__module__ = 'keystoneauth1.identity.v3.receipt'
_abc_impl = <_abc._abc_data object>
_method_parameters: List[str] = ['receipt']
get_auth_data(session: Session, auth: Auth, headers: Dict[str, str], request_kwargs: Dict[str, object], **kwargs: Any) Tuple[None, None] | Tuple[str, Mapping[str, object]]

Add the auth receipt to the headers.

We explicitly return None to avoid being added to the request methods, or body.

get_cache_id_elements() Dict[str, str | None]

Get the elements for this auth method that make it unique.

These elements will be used as part of the keystoneauth1.plugin.BaseIdentityPlugin.get_cache_id() to allow caching of the auth plugin.

Plugins should override this if they want to allow caching of their state.

To avoid collision or overrides the keys of the returned dictionary should be prefixed with the plugin identifier. For example the password plugin returns its username value as ‘password_username’.

receipt: str