cfxdb.mrealm.principal

Classes

Principal

Principals created for use with WAMP authentication. A principal represents the identity

Module Contents

class Principal(oid: uuid.UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, modified: int | None = None, arealm_oid: uuid.UUID | None = None, authid: str | None = None, role_oid: uuid.UUID | None = None, authextra: dict | None = None, _unknown=None)

Bases: cfxdb.common.ConfigurationElement

Principals created for use with WAMP authentication. A principal represents the identity an application client is authenticated to the application realm joined.

A principal must have at least one cfxdb.mrealmschema.Credential added. When an application client connects, it will offer an authmethod and request a realm and (usually) authid. When a matching cfxdb.mrealmschema.Credential is found, and authentication succeeds using that, the client will be authenticated under the cfxdb.mrealmschema.Principal associated with the credential.

Note

It is important to note that while the realm and authid requested by the client (and defined in the respective cfxdb.mrealmschema.Credential) will usually be identical to the realm and authid actually assigned (as defined in the cfxdb.mrealmschema.Principal associated with the credential), this is allowed to differ in general.

__eq__(other)

__ne__(other)

__str__()

_unknown = None

arealm_oid = None

authextra = None

authid = None

copy(other, overwrite=False)

Copy over other object.

Parameters:

other (instance of cfxdb.mrealm.Principal) – Other principal to copy data from.

Returns:

marshal()

Marshal this object to a generic host language object.

Returns:

dict

modified = None

static parse(data)

Parse generic host language object into an object of this class.

Parameters:

data (dict) – Generic host language object

Returns:

instance of ManagementRealm

role_oid = None