Users and Organizations

User

class cfxdb.user.User(oid: Optional[UUID] = None, label: Optional[str] = None, description: Optional[str] = None, tags: Optional[List[str]] = None, email: Optional[str] = None, registered: Optional[datetime] = None, pubkey: Optional[str] = None, _unknown=None)[source]

Bases: ConfigurationElement

Users registered with this master instance.

Note

The user database exists “globally” (master-wide) and independent of management realms. A given user can be owner or authorized to access different management realms or resources therein.

Parameters

  • oid – Object ID of the user

  • label – Optional user label of the user

  • description – Optional user description of the user

  • tags – Optional list of user tags on the user

  • email – User email

  • registered – Timestamp when the user registered

  • pubkey – Public key of user (HEX encoded Ed25519 32 byte public key).

class cfxdb.globalschema.Users(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

Users registered in this domain / master node (user_oid -> user).

class cfxdb.globalschema.IndexUsersByName(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of users by name (user_name -> user_oid).

class cfxdb.globalschema.IndexUsersByPubkey(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of users by pubkey (user_pubkey -> user_oid).

class cfxdb.globalschema.IndexUsersByEmail(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of users by email address (user_email -> user_oid).

class cfxdb.user.UserMrealmRole(roles=None, _unknown=None)[source]

Bases: object

Database class for CFC user roles on a management realm using CBOR.

class cfxdb.globalschema.UserMrealmRoles(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidUuidCbor

User roles on management realms ((mrealm_oid, role_oid) -> role).

class cfxdb.user.ActivationToken(oid=None, atype=None, status=None, created=None, completed=None, code=None, email=None, pubkey=None, _unknown=None)[source]

CFC user activation token database class for CBOR.

class cfxdb.globalschema.ActivationTokens(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

User activations (activation_oid -> activation).

class cfxdb.globalschema.IndexActivationTokensByAuthidPubkey(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of activation tokes by user authid and pubkey ((user_authid, user_pubkey) -> activation_oid).

Organization

class cfxdb.user.Organization(oid: Optional[UUID] = None, label: Optional[str] = None, description: Optional[str] = None, tags: Optional[List[str]] = None, name: Optional[str] = None, otype: Optional[int] = None, registered: Optional[datetime] = None, _unknown=None)[source]

Bases: ConfigurationElement

Organizations created in this master instance.

Parameters

  • oid – Object ID of the organization

  • label – Optional user label of the organization

  • description – Optional user description of the organization

  • tags – Optional list of user tags on the organization

  • name – Name of the organization

  • otype – Type of the organization.

  • registered – Timestamp when the organization was created

OTYPES = [0, 2, 3, 1]

Organization type.

class cfxdb.globalschema.Organizations(slot=None, compress=None, marshal=None, unmarshal=None)[source]

Bases: MapUuidCbor

Organizations defined in this domain / master node (organization_oid -> organization).

class cfxdb.globalschema.IndexOrganizationsByName(slot=None, compress=None)[source]

Bases: MapStringUuid

Index of organizations by name (organization_name -> organization_oid).