Signon.IdentityInfo

Fields

None

Methods

class new ()
  copy ()
  free ()
  get_access_control_list ()
  get_caption ()
  get_id ()
  get_identity_type ()
  get_methods ()
  get_realms ()
  get_storing_secret ()
  get_username ()
  remove_method (method)
  set_access_control_list (access_control_list)
  set_caption (caption)
  set_identity_type (type)
  set_method (method, mechanisms)
  set_realms (realms)
  set_secret (secret, store_secret)
  set_username (username)

Details

class Signon.IdentityInfo

Opaque struct. Use the accessor functions below.

classmethod new()
Returns:a new Signon.IdentityInfo item.
Return type:Signon.IdentityInfo

Creates a new Signon.IdentityInfo item.

copy()
Returns:a copy of the given Signon.IdentityInfo, or None on failure.
Return type:Signon.IdentityInfo

Get a newly-allocated copy of info.

free()

Destroys the given Signon.IdentityInfo item.

get_access_control_list()
Returns:a None terminated array of ACL statements.
Return type:[str]

Get an array of ACL statements of the identity.

get_caption()
Returns:the display name for the identity.
Return type:str

Get the display name of self.

get_id()
Returns:the numeric ID of the identity.
Return type:int

Get the numeric ID of self.

get_identity_type()
Returns:the type of the identity.
Return type:Signon.IdentityType

Get the type of the identity.

get_methods()
Returns:the table of allowed methods and mechanisms.
Return type:{str: [str]}

Get a hash table of the methods and mechanisms of self.

get_realms()
Returns:a None terminated array of realms.
Return type:[str]

Get an array of the realms of self.

get_storing_secret()
Returns:True if Signon must store the secret, False otherwise.
Return type:bool

Get whether the secret of self should be stored.

get_username()
Returns:the username, or None.
Return type:str

Get the username of self.

remove_method(method)
Parameters:method (str) – an authentication method.

Remove method from the list of allowed authentication methods. If all methods are removed, then all methods are allowed.

set_access_control_list(access_control_list)
Parameters:access_control_list (str) – a None-terminated list of ACL security domains.

Specifies the ACL for this identity. The actual meaning of the ACL depends on the security framework used by signond.

set_caption(caption)
Parameters:caption (str) – the caption.

Sets the caption (display name) for the identity.

set_identity_type(type)
Parameters:type (Signon.IdentityType) – the type of the identity.

Specifies the type of this identity.

set_method(method, mechanisms)
Parameters:
  • method (str) – an authentication method.
  • mechanisms (str) – a None-termianted list of mechanisms.

Adds a method to the list of allowed methods. If this method is not called even once, then all methods are allowed. Mechanisms are method-specific variants of authentication.

set_realms(realms)
Parameters:realms (str) – a None-terminated list of realms.

Specify what realms this identity can be used in.

set_secret(secret, store_secret)
Parameters:
  • secret (str) – the secret.
  • store_secret (bool) – whether signond should store the secret in its DB.

Sets the secret (password) for the identity, and whether the signon daemon should remember it.

set_username(username)
Parameters:username (str) – the username.

Sets the username for the identity.