Users and Organizations

---

User

• cfxdb.user.User

• cfxdb.globalschema.Users

• cfxdb.globalschema.IndexUsersByName

• cfxdb.globalschema.IndexUsersByPubkey

• cfxdb.globalschema.IndexUsersByEmail

• cfxdb.user.UserMrealmRole

• cfxdb.globalschema.UserMrealmRoles

• cfxdb.user.ActivationToken

• cfxdb.globalschema.ActivationTokens

• cfxdb.globalschema.IndexActivationTokensByAuthidPubkey

---

class User(oid: UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, email: str | None = None, registered: datetime | None = None, pubkey: str | None = None, _unknown=None)

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.

class Users(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: MapUuidCbor

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

class IndexUsersByName(slot=None, compress=None)

Bases: MapStringUuid

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

class IndexUsersByPubkey(slot=None, compress=None)

Bases: MapStringUuid

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

class IndexUsersByEmail(slot=None, compress=None)

Bases: MapStringUuid

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

class UserMrealmRole(roles=None, _unknown=None)

Bases: object

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

class UserMrealmRoles(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: MapUuidUuidCbor

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

class ActivationToken(oid=None, atype=None, status=None, created=None, completed=None, code=None, email=None, pubkey=None, _unknown=None)

CFC user activation token database class for CBOR.

class ActivationTokens(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: MapUuidCbor

User activations (activation_oid -> activation).

class IndexActivationTokensByAuthidPubkey(slot=None, compress=None)

Bases: MapStringUuid

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

Organization

• cfxdb.user.Organization

• cfxdb.globalschema.Organizations

• cfxdb.globalschema.IndexOrganizationsByName

---

class Organization(oid: UUID | None = None, label: str | None = None, description: str | None = None, tags: List[str] | None = None, name: str | None = None, otype: int | None = None, registered: datetime | None = None, _unknown=None)

Bases: ConfigurationElement

Organizations created in this master instance.

OTYPES = [0, 2, 3, 1]

Organization type.

class Organizations(slot=None, compress=None, marshal=None, unmarshal=None)

Bases: MapUuidCbor

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

class IndexOrganizationsByName(slot=None, compress=None)

Bases: MapStringUuid

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