`icat.authinfo` — Provide the AuthenticatorInfo class¶

Note

This module is used internally in icat.config. Most users will not need to use it directly or even care about it.

class icat.authinfo.AuthenticatorInfo(authInfo)¶

A wrapper around the authenticator info as returned by the ICAT server.

Parameters:	authInfo (`list`) – authenticator information from the ICAT server as returned by `icat.client.Client.getAuthenticatorInfo()`.

getAuthNames()¶: Return a list of authenticator names available at the ICAT server.

getCredentialKeys(auth=None, hide=None)¶

Return credential keys.

Parameters:	auth (`str`) – authenticator name. If given, return only the credential keys for this authenticator. If `None`, return credential keys for all authenticators. hide (`bool`) – if given, return either only the hidden or the non-hidden credential keys, according to the provided value. If `None`, return credential keys for all authenticators.
Returns:	names of credential keys.
Return type:	`set` of `str`
Raises:	KeyError – if auth is provided, but no authenticator by that name is defined in the authenticator information.

Changed in version 0.17.0: add default value for parameter auth.

class icat.authinfo.LegacyAuthenticatorInfo¶

AuthenticatorInfo for old ICAT server.

This is a dummy implementation to emulate AuthenticatorInfo for the case that the server does not support the icat.client.Client.getAuthenticatorInfo() call.

getCredentialKeys(auth=None, hide=None)¶

Return credential keys.

Dummy implementation, pretent that all authenticators expect username and password as credential keys, where password is marked as hidden.

Parameters:	auth (`str`) – authenticator name. This parameter is ignored. hide (`bool`) – if given, return either only the hidden or the non-hidden credential keys, according to the provided value. If `None`, return credential keys for all authenticators.
Returns:	names of credential keys.
Return type:	`set` of `str`

Changed in version 0.17.0: add default value for parameter auth.

icat.authinfo — Provide the AuthenticatorInfo class¶