Reference#
Reference guides are technical descriptions of the machinery and how to operate it. Reference material is information-oriented.
Look things up here. For directions toward a result, read How-to guides. For the reasoning behind any of it, read Concepts.
Writing Python against this package#
One import path for the interfaces, events, content classes, and functions a downstream package needs.
Configuration#
Every registry record the package reads, with type and default.
Every field on the provider form, by tab, and which drivers show it.
The six drivers that ship with the package, their defaults, and the settings each one offers.
Every GenericSetup profile the package ships, what it installs, and the upgrade situation.
Interfaces#
Every REST endpoint and browser view the package publishes.
The routes, settings, and components the volto-identity add-on registers.
The events the package fires, and the normalized claim keys they carry.
Endpoints, scopes, and claims released when a Plone site acts as an authorization server.
The IDriver interface and the rules a driver must satisfy.
Data and storage#
Event names, endpoints, recorded fields, retention settings, and the sink interfaces.
Registry records, marker contracts, and plugin behavior for keeping users and groups as content.
The UserProfile and UserGroup content types: fields, workflow states, containers, the profile gate, and claims refresh.
The JSON format users, groups, and identities are exported as, and read back from.
Every field a migration report carries, and what each one means.
Security and support#
The permissions the package declares and the roles that hold them.
The security properties the test suite enforces, and what to know before deploying.
What is settled and what may still change before 1.0.0.