admin
Vocabularies of the admin API.
List ordering, the named operator controls, and the reasons an access request is declined.
AdminUserSort
¶
Bases: str, Enum
Orderings the admin user list offers.
Each is a column the list can sort on directly; usage-derived orderings (storage, active analyses) are deliberately not offered here.
CREATED_AT = 'created_at'
class-attribute
instance-attribute
¶
Newest accounts first.
EMAIL = 'email'
class-attribute
instance-attribute
¶
Alphabetical by email address.
LAST_LOGIN_AT = 'last_login_at'
class-attribute
instance-attribute
¶
Most recently signed-in first; accounts never signed into come last.
PlatformControlName
¶
Bases: str, Enum
The operator controls an admin can override at runtime.
A control is a platform-wide switch whose configured value an operator can temporarily override — an incident response, never a permanent setting. Each member names one such switch.
API_KEYS = 'api_keys'
class-attribute
instance-attribute
¶
Whether API keys authenticate requests and may be created.
REGISTRATION = 'registration'
class-attribute
instance-attribute
¶
Whether self-registration is open.
SUBMISSIONS = 'submissions'
class-attribute
instance-attribute
¶
Whether analyses may be submitted — single, batch and selector alike.
UPLOADS = 'uploads'
class-attribute
instance-attribute
¶
Whether recordings may be registered for upload.
RegistrationRejectionReason
¶
Bases: str, Enum
Why an access request was declined, in words the applicant is sent.
A fixed list rather than free text, for three reasons. An applicant who is told nothing writes to support, so saying something costs less than saying nothing. A reason written quickly to explain a decision to a colleague becomes an external statement about a named person the moment it is sent. And consistency is impossible to keep by hand across reviewers and over time.
The split that matters is whether the applicant can do anything about it. Three of these invite a fresh application; the rest do not, and say so rather than implying a route that is not there.
AFFILIATION_UNCLEAR = 'affiliation_unclear'
class-attribute
instance-attribute
¶
We could not establish the applicant's institution. Fixable.
IDENTITY_UNVERIFIED = 'identity_unverified'
class-attribute
instance-attribute
¶
The address could not be tied to the person or institution. Fixable.
NOT_ELIGIBLE = 'not_eligible'
class-attribute
instance-attribute
¶
Declined, with no detail given.
For a request that should not be taught how to pass. Carries no explanation to the applicant by design, and the reviewer's own note stays in the audit record.
NO_CAPACITY = 'no_capacity'
class-attribute
instance-attribute
¶
The platform cannot take more accounts at present.
PURPOSE_UNCLEAR = 'purpose_unclear'
class-attribute
instance-attribute
¶
We could not tell what the account would be used for. Fixable.
USAGE_TYPE_NOT_AVAILABLE = 'usage_type_not_available'
class-attribute
instance-attribute
¶
The usage the request describes is not one the platform offers yet.
is_fixable
property
¶
Whether a fresh application could succeed.