Module prelude

A prelude of imports that should be imported by all other Kanidm modules to help make imports cleaner.

Re-exports

pub use crate::entry::Entry;

pub use crate::entry::EntryCommitted;

pub use crate::entry::EntryIncrementalCommitted;

pub use crate::entry::EntryIncrementalNew;

pub use crate::entry::EntryInit;

pub use crate::entry::EntryInitNew;

pub use crate::entry::EntryInvalid;

pub use crate::entry::EntryInvalidCommitted;

pub use crate::entry::EntryInvalidNew;

pub use crate::entry::EntryNew;

pub use crate::entry::EntryReduced;

pub use crate::entry::EntryReducedCommitted;

pub use crate::entry::EntryRefresh;

pub use crate::entry::EntryRefreshNew;

pub use crate::entry::EntrySealed;

pub use crate::entry::EntrySealedCommitted;

pub use crate::entry::EntrySealedNew;

pub use crate::entry::EntryTuple;

pub use crate::entry::EntryValid;

pub use crate::event::CreateEvent;

pub use crate::event::DeleteEvent;

pub use crate::event::ExistsEvent;

pub use crate::event::ModifyEvent;

pub use crate::event::SearchEvent;

pub use crate::filter::f_and;

pub use crate::filter::f_andnot;

pub use crate::filter::f_eq;

pub use crate::filter::f_id;

pub use crate::filter::f_inc;

pub use crate::filter::f_invalid;

pub use crate::filter::f_lt;

pub use crate::filter::f_or;

pub use crate::filter::f_pres;

pub use crate::filter::f_self;

pub use crate::filter::f_spn_name;

pub use crate::filter::f_sub;

pub use crate::filter::Filter;

pub use crate::filter::FilterInvalid;

pub use crate::filter::FilterValid;

pub use crate::filter::FC;

pub use crate::idm::server::IdmServer;

pub use crate::idm::server::IdmServerAudit;

pub use crate::idm::server::IdmServerDelayed;

pub use crate::idm::ClientAuthInfo;

pub use crate::idm::ClientCertInfo;

pub use crate::modify::m_assert;

pub use crate::modify::m_pres;

pub use crate::modify::m_purge;

pub use crate::modify::m_remove;

pub use crate::modify::Modify;

pub use crate::modify::ModifyInvalid;

pub use crate::modify::ModifyList;

pub use crate::modify::ModifyValid;

pub use crate::server::batch_modify::BatchModifyEvent;

pub use crate::server::identity::AccessScope;

pub use crate::server::identity::IdentType;

pub use crate::server::identity::IdentUser;

pub use crate::server::identity::Identity;

pub use crate::server::identity::IdentityId;

pub use crate::server::identity::Source;

pub use crate::server::QueryServer;

pub use crate::server::QueryServerReadTransaction;

pub use crate::server::QueryServerTransaction;

pub use crate::server::QueryServerWriteTransaction;

pub use crate::time::duration_from_epoch_now;

pub use crate::value::ApiTokenScope;

pub use crate::value::IndexType;

pub use crate::value::PartialValue;

pub use crate::value::SessionScope;

pub use crate::value::SyntaxType;

pub use crate::value::Value;

pub use crate::constants::*;

Modules

uri

Shared URIs

Macros

admin_debug

admin_error

admin_info

admin_warn

filter_error

filter_info

filter_trace

filter_warn

perf_trace

request_error

request_info

request_trace

request_warn

security_access

security_critical

security_debug

security_error

security_info

tagged_event

uuid

Parse Uuids from string literals at compile time.

Structs

Cid

Duration

A Duration type to represent a span of time, typically used for system timeouts.

Rfc3339

The format described in RFC 3339.

Url

A parsed URL record.

Uuid

A Universally Unique Identifier (UUID).

Enums

Attribute

ConsistencyError

EventTag

OperationError

PluginError

SchemaError

Constants

ACCESS_CONTROL_CREATE

ACCESS_CONTROL_DELETE

ACCESS_CONTROL_MODIFY

ACCESS_CONTROL_PROFILE

ACCESS_CONTROL_RECEIVER_ENTRY_MANAGER

ACCESS_CONTROL_RECEIVER_GROUP

ACCESS_CONTROL_SEARCH

ACCESS_CONTROL_TARGET_SCOPE

APPLICATION_JSON

ATTR_ACCOUNT

ATTR_ACCOUNT_EXPIRE

ATTR_ACCOUNT_VALID_FROM

ATTR_ACP_CREATE_ATTR

ATTR_ACP_CREATE_CLASS

ATTR_ACP_ENABLE

ATTR_ACP_MODIFY_CLASS

ATTR_ACP_MODIFY_PRESENTATTR

ATTR_ACP_MODIFY_PRESENT_CLASS

ATTR_ACP_MODIFY_REMOVEDATTR

ATTR_ACP_MODIFY_REMOVE_CLASS

ATTR_ACP_RECEIVER

ATTR_ACP_RECEIVER_GROUP

ATTR_ACP_SEARCH_ATTR

ATTR_ACP_TARGET_SCOPE

ATTR_ALLOW_PRIMARY_CRED_FALLBACK

ATTR_API_TOKEN_SESSION

ATTR_APPLICATION_PASSWORD

ATTR_ATTESTED_PASSKEYS

ATTR_ATTR

ATTR_ATTRIBUTENAME

ATTR_ATTRIBUTETYPE

ATTR_AUTH_PASSWORD_MINIMUM_LENGTH

ATTR_AUTH_SESSION_EXPIRY

ATTR_BADLIST_PASSWORD

ATTR_CERTIFICATE

ATTR_CLAIM

ATTR_CLASS

ATTR_CLASSNAME

ATTR_CN

ATTR_COOKIE_PRIVATE_KEY

ATTR_CREATED_AT_CID

ATTR_CREDENTIAL_TYPE_MINIMUM

ATTR_CREDENTIAL_UPDATE_INTENT_TOKEN

ATTR_DENIED_NAME

ATTR_DESCRIPTION

ATTR_DIRECTMEMBEROF

ATTR_DISPLAYNAME

ATTR_DN

ATTR_DOMAIN

ATTR_DOMAIN_ALLOW_EASTER_EGGS

ATTR_DOMAIN_DEVELOPMENT_TAINT

ATTR_DOMAIN_DISPLAY_NAME

ATTR_DOMAIN_LDAP_BASEDN

ATTR_DOMAIN_NAME

ATTR_DOMAIN_SSID

ATTR_DOMAIN_TOKEN_KEY

ATTR_DOMAIN_UUID

ATTR_DYNGROUP

ATTR_DYNGROUP_FILTER

ATTR_DYNMEMBER

ATTR_EMAIL

ATTR_EMAIL_ALTERNATIVE

ATTR_EMAIL_PRIMARY

ATTR_ENTRYDN

ATTR_ENTRYUUID

ATTR_ENTRY_MANAGED_BY

ATTR_ES256_PRIVATE_KEY_DER

ATTR_EXCLUDES

ATTR_FERNET_PRIVATE_KEY_STR

ATTR_GECOS

ATTR_GIDNUMBER

ATTR_GRANT_UI_HINT

ATTR_GROUP

ATTR_ID_VERIFICATION_ECKEY

ATTR_IMAGE

ATTR_INDEX

ATTR_INDEXED

ATTR_IPANTHASH

ATTR_IPASSHPUBKEY

ATTR_JWS_ES256_PRIVATE_KEY

ATTR_KEY_ACTION_IMPORT_JWS_ES256

ATTR_KEY_ACTION_IMPORT_JWS_RS256

ATTR_KEY_ACTION_REVOKE

ATTR_KEY_ACTION_ROTATE

ATTR_KEY_INTERNAL_DATA

ATTR_KEY_PROVIDER

ATTR_LAST_MODIFIED_CID

ATTR_LDAP_ALLOW_UNIX_PW_BIND

ATTR_LDAP_EMAIL_ADDRESS

ATTR_LDAP_KEYS

ATTR_LDAP_MAX_QUERYABLE_ATTRS

ATTR_LDAP_SSHPUBLICKEY

ATTR_LEGALNAME

ATTR_LIMIT_SEARCH_MAX_FILTER_TEST

ATTR_LIMIT_SEARCH_MAX_RESULTS

ATTR_LINKEDGROUP

ATTR_LOGINSHELL

ATTR_MAIL

ATTR_MAY

ATTR_MEMBER

ATTR_MEMBEROF

ATTR_MULTIVALUE

ATTR_MUST

ATTR_NAME

ATTR_NAME_HISTORY

ATTR_NO_INDEX

ATTR_NSACCOUNTLOCK

ATTR_NSUNIQUEID

ATTR_OAUTH2_ALLOW_INSECURE_CLIENT_DISABLE_PKCE

ATTR_OAUTH2_ALLOW_LOCALHOST_REDIRECT

ATTR_OAUTH2_CONSENT_SCOPE_MAP

ATTR_OAUTH2_DEVICE_FLOW_ENABLE

ATTR_OAUTH2_JWT_LEGACY_CRYPTO_ENABLE

ATTR_OAUTH2_PREFER_SHORT_USERNAME

ATTR_OAUTH2_RS_BASIC_SECRET

ATTR_OAUTH2_RS_CLAIM_MAP

ATTR_OAUTH2_RS_IMPLICIT_SCOPES

ATTR_OAUTH2_RS_NAME

ATTR_OAUTH2_RS_ORIGIN

ATTR_OAUTH2_RS_ORIGIN_LANDING

ATTR_OAUTH2_RS_SCOPE_MAP

ATTR_OAUTH2_RS_SUP_SCOPE_MAP

ATTR_OAUTH2_RS_TOKEN_KEY

ATTR_OAUTH2_SESSION

ATTR_OAUTH2_STRICT_REDIRECT_URI

ATTR_OBJECTCLASS

ATTR_OTHER_NO_INDEX

ATTR_PASSKEYS

ATTR_PASSWORD_IMPORT

ATTR_PATCH_LEVEL

ATTR_PHANTOM

ATTR_PRIMARY_CREDENTIAL

ATTR_PRIVATE_COOKIE_KEY

ATTR_PRIVILEGE_EXPIRY

ATTR_RADIUS_SECRET

ATTR_RECYCLED

ATTR_RECYCLEDDIRECTMEMBEROF

ATTR_REFERS

ATTR_REPLICATED

ATTR_RS256_PRIVATE_KEY_DER

ATTR_SCIM_SCHEMAS

ATTR_SCOPE

ATTR_SELF

ATTR_SOURCE_UUID

ATTR_SPN

ATTR_SSH_PUBLICKEY

ATTR_SUDOHOST

ATTR_SUPPLEMENTS

ATTR_SYNC_ALLOWED

ATTR_SYNC_CLASS

ATTR_SYNC_COOKIE

ATTR_SYNC_CREDENTIAL_PORTAL

ATTR_SYNC_EXTERNAL_ID

ATTR_SYNC_EXTERNAL_UUID

ATTR_SYNC_PARENT_UUID

ATTR_SYNC_TOKEN_SESSION

ATTR_SYNC_YIELD_AUTHORITY

ATTR_SYNTAX

ATTR_SYSTEMEXCLUDES

ATTR_SYSTEMMAY

ATTR_SYSTEMMUST

ATTR_SYSTEMSUPPLEMENTS

ATTR_TERM

ATTR_TOTP_IMPORT

ATTR_UID

ATTR_UIDNUMBER

ATTR_UNIQUE

ATTR_UNIX_PASSWORD

ATTR_UNIX_PASSWORD_IMPORT

ATTR_USERID

ATTR_USERPASSWORD

ATTR_USER_AUTH_TOKEN_SESSION

ATTR_UUID

ATTR_VERSION

ATTR_WEBAUTHN_ATTESTATION_CA_LIST

AUTH_TOKEN_GRACE_WINDOW

Default grace window for authentication tokens. This allows a token to be validated by another replica before the backing database session has been replicated to the partner. If replication stalls until this point then the token will be considered INVALID.

CLIENT_TOKEN_CACHE

The default location for the kanidm CLI tool’s token cache.

CONTENT_TYPE_GIF

Content type string for gif

CONTENT_TYPE_JPG

Content type string for jpeg

CONTENT_TYPE_PNG

Content type string for png

CONTENT_TYPE_SVG

Content type string for svg

CONTENT_TYPE_WEBP

Content type string for webp

DEFAULT_CLIENT_CONFIG_PATH

The “system” path for Kanidm client config

DEFAULT_CLIENT_CONFIG_PATH_HOME

The user-owned path for Kanidm client config

DEFAULT_LDAP_LOCALHOST

The default LDAP bind address for the Kanidm client

DEFAULT_LDAP_MAXIMUM_QUERYABLE_ATTRIBUTES

The default amount of attributes that can be queried in LDAP

DEFAULT_REPLICATION_ADDRESS

Default replication configuration

DEFAULT_REPLICATION_ORIGIN

DEFAULT_REPL_TASK_POLL_INTERVAL

Default replication poll window in seconds.

DEFAULT_SERVER_ADDRESS

The default HTTPS bind address for the Kanidm server

DEFAULT_SERVER_LOCALHOST

ENTRYCLASS_ACCOUNT

ENTRYCLASS_ACCOUNT_POLICY

ENTRYCLASS_APPLICATION

ENTRYCLASS_ATTRIBUTE_TYPE

ENTRYCLASS_BUILTIN

Entryclass

ENTRYCLASS_CLASS

ENTRYCLASS_CLASS_TYPE

ENTRYCLASS_CLIENT_CERTIFICATE

ENTRYCLASS_CONFLICT

ENTRYCLASS_DOMAIN_INFO

ENTRYCLASS_DYN_GROUP

ENTRYCLASS_EXTENSIBLE_OBJECT

ENTRYCLASS_GROUP

ENTRYCLASS_KEY_OBJECT

ENTRYCLASS_KEY_OBJECT_INTERNAL

ENTRYCLASS_KEY_OBJECT_JWE_A128GCM

ENTRYCLASS_KEY_OBJECT_JWT_ES256

ENTRYCLASS_KEY_OBJECT_JWT_RS256

ENTRYCLASS_KEY_PROVIDER

ENTRYCLASS_KEY_PROVIDER_INTERNAL

ENTRYCLASS_MEMBER_OF

ENTRYCLASS_OBJECT

ENTRYCLASS_ORG_PERSON

ENTRYCLASS_PERSON

ENTRYCLASS_POSIX_ACCOUNT

ENTRYCLASS_POSIX_GROUP

ENTRYCLASS_RECYCLED

ENTRYCLASS_SERVICE

ENTRYCLASS_SERVICE_ACCOUNT

ENTRYCLASS_SYNC_ACCOUNT

ENTRYCLASS_SYNC_OBJECT

ENTRYCLASS_SYSTEM

ENTRYCLASS_SYSTEM_CONFIG

ENTRYCLASS_SYSTEM_INFO

ENTRYCLASS_TOMBSTONE

ENTRYCLASS_USER

KOPID

HTTP Header containing the backend operation ID

KSESSIONID

HTTP Header containing an auth session ID for when you’re going through an auth flow

KVERSION

HTTP Header containing the Kanidm server version

LDAP_ATTR_CN

LDAP_ATTR_DISPLAY_NAME

LDAP_ATTR_DN

LDAP_ATTR_EMAIL_ALTERNATIVE

LDAP_ATTR_EMAIL_PRIMARY

LDAP_ATTR_ENTRYDN

LDAP_ATTR_ENTRYUUID

LDAP_ATTR_GROUPS

LDAP_ATTR_KEYS

LDAP_ATTR_MAIL

LDAP_ATTR_MAIL_ALTERNATIVE

LDAP_ATTR_MAIL_PRIMARY

LDAP_ATTR_MEMBER

LDAP_ATTR_NAME

LDAP_ATTR_OBJECTCLASS

LDAP_ATTR_OU

LDAP_ATTR_UID

LDAP_CLASS_GROUPOFNAMES

OAUTH2_DEVICE_CODE_SESSION

OAUTH2_RESOURCE_SERVER

OAUTH2_RESOURCE_SERVER_BASIC

OAUTH2_RESOURCE_SERVER_PUBLIC

OAUTH2_SCOPE_EMAIL

OAUTH2_SCOPE_GROUPS

OAUTH2_SCOPE_OPENID

OAUTH2_SCOPE_READ

OAUTH2_SCOPE_SSH_PUBLICKEYS

OAUTH2_SCOPE_SUPPLEMENT

SUB_ATTR_PRIMARY

TEST_ATTR_EXTRA

TEST_ATTR_NON_EXIST

TEST_ATTR_NOTALLOWED

TEST_ATTR_NUMBER

TEST_ATTR_TEST_ATTR

TEST_ENTRYCLASS_TEST_CLASS

VALID_IMAGE_UPLOAD_CONTENT_TYPES

X_FORWARDED_FOR

X-Forwarded-For header

Traits

AccessControlsTransaction

Type Aliases

AttrString

A convenience alias for a [LazyCompact] layout [SmartString].