Directories
¶
| Path | Synopsis |
|---|---|
|
Group and group-owner resource authorization (GroupPolicy, Groups::GroupOwnerPolicy).
|
Group and group-owner resource authorization (GroupPolicy, Groups::GroupOwnerPolicy). |
|
Package accounts is the account scenario: the single account's bootstrap and (later) its settings.
|
Package accounts is the account scenario: the single account's bootstrap and (later) its settings. |
|
Package apperr is the typed application error: everything a handler needs to render a Keygen error document (status, title, detail, code, source pointer/parameter/header, docs link).
|
Package apperr is the typed application error: everything a handler needs to render a Keygen error document (status, title, detail, code, source pointer/parameter/header, docs link). |
|
Package authn is the authentication scenario: every Authorization scheme and the ?token=/?auth= query form, resolved to a principal.
|
Package authn is the authentication scenario: every Authorization scheme and the ?token=/?auth= query form, resolved to a principal. |
|
Package automation records installation automation in the same transaction as Keygen webhooks.
|
Package automation records installation automation in the same transaction as Keygen webhooks. |
|
Package catalog is the declared catalog: products, their policies and named product tokens of fixed value, taken from the configuration and reconciled at startup.
|
Package catalog is the declared catalog: products, their policies and named product tokens of fixed value, taken from the configuration and reconciled at startup. |
|
Package entitlements is the entitlement scenario: the account-level CRUD of the features policies and licenses attach.
|
Package entitlements is the entitlement scenario: the account-level CRUD of the features policies and licenses attach. |
|
Package events is where scenarios report what happened: a Keygen webhook event ("license.created", "machine.heartbeat.ping", …) with the resource document it carries.
|
Package events is where scenarios report what happened: a Keygen webhook event ("license.created", "machine.heartbeat.ping", …) with the resource document it carries. |
|
Package groups is the group scenario: CRUD, the member relationship indexes and the owners join resource.
|
Package groups is the group scenario: CRUD, the member relationship indexes and the owners join resource. |
|
Package jobs is the periodic-jobs runner: every tick takes a PG advisory xact lock so exactly one replica runs it, then runs the jobs that are due — the heartbeat cull and the prunes Keygen runs on cron (sidekiq-cron).
|
Package jobs is the periodic-jobs runner: every tick takes a PG advisory xact lock so exactly one replica runs it, then runs the jobs that are due — the heartbeat cull and the prunes Keygen runs on cron (sidekiq-cron). |
|
Package keys is the key scenario: the members of pooled policies' key pools (create requires a pooled policy; the pool itself lives under /policies/{id}/pool).
|
Package keys is the key scenario: the members of pooled policies' key pools (create requires a pooled policy; the pool itself lives under /policies/{id}/pool). |
|
License actions: revoke, renew, suspend, reinstate, check-in and the usage counters.
|
License actions: revoke, renew, suspend, reinstate, check-in and the usage counters. |
|
Package machines is the machine scenario: index, show, activation, update, deactivation, the heartbeat actions, machine-file check-outs and the relationship routes (product, license, owner, user, group).
|
Package machines is the machine scenario: index, show, activation, update, deactivation, the heartbeat actions, machine-file check-outs and the relationship routes (product, license, owner, user, group). |
|
Package paging parses the three pagination modes (limit, offset, keyset) and the order parameter exactly like the reference, and builds the collection links (with pagination meta nested in links).
|
Package paging parses the three pagination modes (limit, offset, keyset) and the order parameter exactly like the reference, and builds the collection links (with pagination meta nested in links). |
|
Package passwords is the password-reset request scenario (POST /passwords): always a 204, indistinguishable for unknown emails.
|
Package passwords is the password-reset request scenario (POST /passwords): always a 204, indistinguishable for unknown emails. |
|
Package policies is the policy scenario: CRUD over the full attribute surface, the product/license relationship routes, the key pool and entitlement attach/detach.
|
Package policies is the policy scenario: CRUD over the full attribute surface, the product/license relationship routes, the key pool and entitlement attach/detach. |
|
Package products is the product scenario: CRUD, the product's relationship routes (policies, licenses, machines, tokens, users) and product-token generation.
|
Package products is the product scenario: CRUD, the product's relationship routes (policies, licenses, machines, tokens, users) and product-token generation. |
|
Package search is POST /search: it validates a typed query, authorizes the bearer, and resolves the matching ids of one resource type.
|
Package search is POST /search: it validates a typed query, authorizes the bearer, and resolves the matching ids of one resource type. |
|
Package secondfactors is the TOTP second-factor scenario: create (secret revealed), enable/disable (OTP-verified), delete, and the index/show reads.
|
Package secondfactors is the TOTP second-factor scenario: create (secret revealed), enable/disable (OTP-verified), delete, and the index/show reads. |
|
Package telemetry is lic's business counters: validations by their code, activations, check-outs and usage reports by outcome.
|
Package telemetry is lic's business counters: validations by their code, activations, check-outs and usage reports by outcome. |
|
Package tokens is the token scenario: generation (the POST /tokens endpoint).
|
Package tokens is the token scenario: generation (the POST /tokens endpoint). |
|
Package users is the user scenario: the bootstrap admin seed, the status computation, CRUD, the password/ban actions and the relationship reads (me/profile included).
|
Package users is the user scenario: the bootstrap admin seed, the status computation, CRUD, the password/ban actions and the relationship reads (me/profile included). |
|
Package webhooks is the webhook scenario: endpoint CRUD (the URL, subscription and signature rules), the webhook-events routes (index, show, destroy, retry) and the event publisher that writes the outbox rows inside the caller's transaction.
|
Package webhooks is the webhook scenario: endpoint CRUD (the URL, subscription and signature rules), the webhook-events routes (index, show, destroy, retry) and the event publisher that writes the outbox rows inside the caller's transaction. |
Click to show internal directories.
Click to hide internal directories.