Documentation
authentik CLI
authentik-pp-cli
Install
npx -y @mvanhorn/printing-press-library install authentikInstalls the CLI binary and the agent skill for Claude Code, Codex, Cursor, Gemini CLI, Copilot, and more. Add --cli-only or --skill-only for one half. Requires Node.
Documentation
Agent-native admin CLI for authentik identity provider with offline SQLite cache and an MCP server for Claude Desktop.
Inspect users, groups, applications, flows, tokens, and providers from the terminal or from Claude. Sync once, query offline, audit with a single command.
Printed by @CarlF01 (CFinney).
Authentication
authentik uses Bearer token auth. Create an API token in the admin UI (Directory > Tokens) and set AUTHENTIK_TOKEN in your environment.
Quick Start
# Verify auth and reachability
authentik-pp-cli doctor
# One-shot operator health snapshot
authentik-pp-cli health --json
# Cache users, groups, apps, flows locally
authentik-pp-cli sync --full
# List users with selected fields
authentik-pp-cli core users_list --json --select results.username,results.is_active
# Audit unused API tokens
authentik-pp-cli tokens stale --days 90 --json
Unique Features
These capabilities aren't available in any other tool for this API.
health— Joins admin/system + tasks + workers + version into a single agent-readable summarytokens stale— Find API tokens whose owners have not used them in N daysapps unused— List applications with no successful login in N daysusers groups— Recursively expand a user's group memberships including inherited rolesflows map— Render a flow with its ordered stage bindings as a tree
Usage
Run authentik-pp-cli --help for the full command reference and flag list.
Commands
admin
Manage admin
authentik-pp-cli admin apps-list- Read-only view list all installed appsauthentik-pp-cli admin models-list- Read-only view list all installed modelsauthentik-pp-cli admin settings-partial-update- Settings viewauthentik-pp-cli admin settings-retrieve- Settings viewauthentik-pp-cli admin settings-update- Settings viewauthentik-pp-cli admin system-create- Get system information.authentik-pp-cli admin system-retrieve- Get system information.authentik-pp-cli admin version-history-list- VersionHistory Viewsetauthentik-pp-cli admin version-history-retrieve- VersionHistory Viewsetauthentik-pp-cli admin version-retrieve- Get running and latest version.
authenticators
Manage authenticators
authentik-pp-cli authenticators admin-all-list- Get all devices for current userauthentik-pp-cli authenticators admin-duo-create- Viewset for Duo authenticator devices (for admins)authentik-pp-cli authenticators admin-duo-destroy- Viewset for Duo authenticator devices (for admins)authentik-pp-cli authenticators admin-duo-list- Viewset for Duo authenticator devices (for admins)authentik-pp-cli authenticators admin-duo-partial-update- Viewset for Duo authenticator devices (for admins)authentik-pp-cli authenticators admin-duo-retrieve- Viewset for Duo authenticator devices (for admins)authentik-pp-cli authenticators admin-duo-update- Viewset for Duo authenticator devices (for admins)authentik-pp-cli authenticators admin-email-create- Viewset for email authenticator devices (for admins)authentik-pp-cli authenticators admin-email-destroy- Viewset for email authenticator devices (for admins)authentik-pp-cli authenticators admin-email-list- Viewset for email authenticator devices (for admins)authentik-pp-cli authenticators admin-email-partial-update- Viewset for email authenticator devices (for admins)authentik-pp-cli authenticators admin-email-retrieve- Viewset for email authenticator devices (for admins)authentik-pp-cli authenticators admin-email-update- Viewset for email authenticator devices (for admins)authentik-pp-cli authenticators admin-endpoint-create- Viewset for Endpoint authenticator devices (for admins)authentik-pp-cli authenticators admin-endpoint-destroy- Viewset for Endpoint authenticator devices (for admins)authentik-pp-cli authenticators admin-endpoint-list- Viewset for Endpoint authenticator devices (for admins)authentik-pp-cli authenticators admin-endpoint-partial-update- Viewset for Endpoint authenticator devices (for admins)authentik-pp-cli authenticators admin-endpoint-retrieve- Viewset for Endpoint authenticator devices (for admins)authentik-pp-cli authenticators admin-endpoint-update- Viewset for Endpoint authenticator devices (for admins)authentik-pp-cli authenticators admin-sms-create- Viewset for sms authenticator devices (for admins)authentik-pp-cli authenticators admin-sms-destroy- Viewset for sms authenticator devices (for admins)authentik-pp-cli authenticators admin-sms-list- Viewset for sms authenticator devices (for admins)authentik-pp-cli authenticators admin-sms-partial-update- Viewset for sms authenticator devices (for admins)authentik-pp-cli authenticators admin-sms-retrieve- Viewset for sms authenticator devices (for admins)authentik-pp-cli authenticators admin-sms-update- Viewset for sms authenticator devices (for admins)authentik-pp-cli authenticators admin-static-create- Viewset for static authenticator devices (for admins)authentik-pp-cli authenticators admin-static-destroy- Viewset for static authenticator devices (for admins)authentik-pp-cli authenticators admin-static-list- Viewset for static authenticator devices (for admins)authentik-pp-cli authenticators admin-static-partial-update- Viewset for static authenticator devices (for admins)authentik-pp-cli authenticators admin-static-retrieve- Viewset for static authenticator devices (for admins)authentik-pp-cli authenticators admin-static-update- Viewset for static authenticator devices (for admins)authentik-pp-cli authenticators admin-totp-create- Viewset for totp authenticator devices (for admins)authentik-pp-cli authenticators admin-totp-destroy- Viewset for totp authenticator devices (for admins)authentik-pp-cli authenticators admin-totp-list- Viewset for totp authenticator devices (for admins)authentik-pp-cli authenticators admin-totp-partial-update- Viewset for totp authenticator devices (for admins)authentik-pp-cli authenticators admin-totp-retrieve- Viewset for totp authenticator devices (for admins)authentik-pp-cli authenticators admin-totp-update- Viewset for totp authenticator devices (for admins)authentik-pp-cli authenticators admin-webauthn-create- Viewset for WebAuthn authenticator devices (for admins)authentik-pp-cli authenticators admin-webauthn-destroy- Viewset for WebAuthn authenticator devices (for admins)authentik-pp-cli authenticators admin-webauthn-list- Viewset for WebAuthn authenticator devices (for admins)authentik-pp-cli authenticators admin-webauthn-partial-update- Viewset for WebAuthn authenticator devices (for admins)authentik-pp-cli authenticators admin-webauthn-retrieve- Viewset for WebAuthn authenticator devices (for admins)authentik-pp-cli authenticators admin-webauthn-update- Viewset for WebAuthn authenticator devices (for admins)authentik-pp-cli authenticators all-list- Get all devices for current userauthentik-pp-cli authenticators duo-destroy- Viewset for Duo authenticator devicesauthentik-pp-cli authenticators duo-list- Viewset for Duo authenticator devicesauthentik-pp-cli authenticators duo-partial-update- Viewset for Duo authenticator devicesauthentik-pp-cli authenticators duo-retrieve- Viewset for Duo authenticator devicesauthentik-pp-cli authenticators duo-update- Viewset for Duo authenticator devicesauthentik-pp-cli authenticators duo-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli authenticators email-destroy- Viewset for email authenticator devicesauthentik-pp-cli authenticators email-list- Viewset for email authenticator devicesauthentik-pp-cli authenticators email-partial-update- Viewset for email authenticator devicesauthentik-pp-cli authenticators email-retrieve- Viewset for email authenticator devicesauthentik-pp-cli authenticators email-update- Viewset for email authenticator devicesauthentik-pp-cli authenticators email-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli authenticators endpoint-list- Viewset for Endpoint authenticator devicesauthentik-pp-cli authenticators endpoint-retrieve- Viewset for Endpoint authenticator devicesauthentik-pp-cli authenticators endpoint-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli authenticators sms-destroy- Viewset for sms authenticator devicesauthentik-pp-cli authenticators sms-list- Viewset for sms authenticator devicesauthentik-pp-cli authenticators sms-partial-update- Viewset for sms authenticator devicesauthentik-pp-cli authenticators sms-retrieve- Viewset for sms authenticator devicesauthentik-pp-cli authenticators sms-update- Viewset for sms authenticator devicesauthentik-pp-cli authenticators sms-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli authenticators static-destroy- Viewset for static authenticator devicesauthentik-pp-cli authenticators static-list- Viewset for static authenticator devicesauthentik-pp-cli authenticators static-partial-update- Viewset for static authenticator devicesauthentik-pp-cli authenticators static-retrieve- Viewset for static authenticator devicesauthentik-pp-cli authenticators static-update- Viewset for static authenticator devicesauthentik-pp-cli authenticators static-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli authenticators totp-destroy- Viewset for totp authenticator devicesauthentik-pp-cli authenticators totp-list- Viewset for totp authenticator devicesauthentik-pp-cli authenticators totp-partial-update- Viewset for totp authenticator devicesauthentik-pp-cli authenticators totp-retrieve- Viewset for totp authenticator devicesauthentik-pp-cli authenticators totp-update- Viewset for totp authenticator devicesauthentik-pp-cli authenticators totp-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli authenticators webauthn-destroy- Viewset for WebAuthn authenticator devicesauthentik-pp-cli authenticators webauthn-list- Viewset for WebAuthn authenticator devicesauthentik-pp-cli authenticators webauthn-partial-update- Viewset for WebAuthn authenticator devicesauthentik-pp-cli authenticators webauthn-retrieve- Viewset for WebAuthn authenticator devicesauthentik-pp-cli authenticators webauthn-update- Viewset for WebAuthn authenticator devicesauthentik-pp-cli authenticators webauthn-used-by-list- Get a list of all objects that use this object
core
Manage core
authentik-pp-cli core application-entitlements-create- ApplicationEntitlement Viewsetauthentik-pp-cli core application-entitlements-destroy- ApplicationEntitlement Viewsetauthentik-pp-cli core application-entitlements-list- ApplicationEntitlement Viewsetauthentik-pp-cli core application-entitlements-partial-update- ApplicationEntitlement Viewsetauthentik-pp-cli core application-entitlements-retrieve- ApplicationEntitlement Viewsetauthentik-pp-cli core application-entitlements-update- ApplicationEntitlement Viewsetauthentik-pp-cli core application-entitlements-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli core applications-check-access-retrieve- Check access to a single application by slugauthentik-pp-cli core applications-create- Application Viewsetauthentik-pp-cli core applications-destroy- Application Viewsetauthentik-pp-cli core applications-list- Custom list method that checks Policy based access instead of guardianauthentik-pp-cli core applications-partial-update- Application Viewsetauthentik-pp-cli core applications-retrieve- Application Viewsetauthentik-pp-cli core applications-set-icon-create- Set application iconauthentik-pp-cli core applications-set-icon-url-create- Set application icon (as URL)authentik-pp-cli core applications-update- Application Viewsetauthentik-pp-cli core applications-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli core authenticated-sessions-destroy- AuthenticatedSession Viewsetauthentik-pp-cli core authenticated-sessions-list- AuthenticatedSession Viewsetauthentik-pp-cli core authenticated-sessions-retrieve- AuthenticatedSession Viewsetauthentik-pp-cli core authenticated-sessions-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli core brands-create- Brand Viewsetauthentik-pp-cli core brands-current-retrieve- Get current brandauthentik-pp-cli core brands-destroy- Brand Viewsetauthentik-pp-cli core brands-list- Brand Viewsetauthentik-pp-cli core brands-partial-update- Brand Viewsetauthentik-pp-cli core brands-retrieve- Brand Viewsetauthentik-pp-cli core brands-update- Brand Viewsetauthentik-pp-cli core brands-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli core groups-add-user-create- Add user to groupauthentik-pp-cli core groups-create- Group Viewsetauthentik-pp-cli core groups-destroy- Group Viewsetauthentik-pp-cli core groups-list- Group Viewsetauthentik-pp-cli core groups-partial-update- Group Viewsetauthentik-pp-cli core groups-remove-user-create- Remove user from groupauthentik-pp-cli core groups-retrieve- Group Viewsetauthentik-pp-cli core groups-update- Group Viewsetauthentik-pp-cli core groups-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli core tokens-create- Token Viewsetauthentik-pp-cli core tokens-destroy- Token Viewsetauthentik-pp-cli core tokens-list- Token Viewsetauthentik-pp-cli core tokens-partial-update- Token Viewsetauthentik-pp-cli core tokens-retrieve- Token Viewsetauthentik-pp-cli core tokens-set-key-create- Set token key. Action is logged as event.authentik_core.set_token_keypermission is required.authentik-pp-cli core tokens-update- Token Viewsetauthentik-pp-cli core tokens-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli core tokens-view-key-retrieve- Return token key and log accessauthentik-pp-cli core transactional-applications-update- Convert data into a blueprint, validate it and apply itauthentik-pp-cli core user-consent-destroy- UserConsent Viewsetauthentik-pp-cli core user-consent-list- UserConsent Viewsetauthentik-pp-cli core user-consent-retrieve- UserConsent Viewsetauthentik-pp-cli core user-consent-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli core users-create- User Viewsetauthentik-pp-cli core users-destroy- User Viewsetauthentik-pp-cli core users-impersonate-create- Impersonate a userauthentik-pp-cli core users-impersonate-end-retrieve- End Impersonation a userauthentik-pp-cli core users-list- User Viewsetauthentik-pp-cli core users-me-retrieve- Get information about current userauthentik-pp-cli core users-partial-update- User Viewsetauthentik-pp-cli core users-paths-retrieve- Get all user pathsauthentik-pp-cli core users-recovery-create- Create a temporary link that a user can use to recover their accountauthentik-pp-cli core users-recovery-email-create- Send an email with a temporary link that a user can use to recover their accountauthentik-pp-cli core users-retrieve- User Viewsetauthentik-pp-cli core users-service-account-create- Create a new user account that is marked as a service accountauthentik-pp-cli core users-set-password-create- Set password for userauthentik-pp-cli core users-update- User Viewsetauthentik-pp-cli core users-used-by-list- Get a list of all objects that use this object
enterprise
Manage enterprise
authentik-pp-cli enterprise license-create- License Viewsetauthentik-pp-cli enterprise license-destroy- License Viewsetauthentik-pp-cli enterprise license-forecast-retrieve- Forecast how many users will be required in a yearauthentik-pp-cli enterprise license-install-id-retrieve- Get install_idauthentik-pp-cli enterprise license-list- License Viewsetauthentik-pp-cli enterprise license-partial-update- License Viewsetauthentik-pp-cli enterprise license-retrieve- License Viewsetauthentik-pp-cli enterprise license-summary-retrieve- Get the total license statusauthentik-pp-cli enterprise license-update- License Viewsetauthentik-pp-cli enterprise license-used-by-list- Get a list of all objects that use this object
events
Manage events
authentik-pp-cli events actions-list- Get all actionsauthentik-pp-cli events create- Event Read-Only Viewsetauthentik-pp-cli events destroy- Event Read-Only Viewsetauthentik-pp-cli events list- Event Read-Only Viewsetauthentik-pp-cli events notifications-destroy- Notification Viewsetauthentik-pp-cli events notifications-list- Notification Viewsetauthentik-pp-cli events notifications-mark-all-seen-create- Mark all the user's notifications as seenauthentik-pp-cli events notifications-partial-update- Notification Viewsetauthentik-pp-cli events notifications-retrieve- Notification Viewsetauthentik-pp-cli events notifications-update- Notification Viewsetauthentik-pp-cli events notifications-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli events partial-update- Event Read-Only Viewsetauthentik-pp-cli events retrieve- Event Read-Only Viewsetauthentik-pp-cli events rules-create- NotificationRule Viewsetauthentik-pp-cli events rules-destroy- NotificationRule Viewsetauthentik-pp-cli events rules-list- NotificationRule Viewsetauthentik-pp-cli events rules-partial-update- NotificationRule Viewsetauthentik-pp-cli events rules-retrieve- NotificationRule Viewsetauthentik-pp-cli events rules-update- NotificationRule Viewsetauthentik-pp-cli events rules-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli events top-per-user-list- Get the top_n events grouped by user countauthentik-pp-cli events transports-create- NotificationTransport Viewsetauthentik-pp-cli events transports-destroy- NotificationTransport Viewsetauthentik-pp-cli events transports-list- NotificationTransport Viewsetauthentik-pp-cli events transports-partial-update- NotificationTransport Viewsetauthentik-pp-cli events transports-retrieve- NotificationTransport Viewsetauthentik-pp-cli events transports-test-create- Send example notification using selected transport. Requires Modify permissions.authentik-pp-cli events transports-update- NotificationTransport Viewsetauthentik-pp-cli events transports-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli events update- Event Read-Only Viewsetauthentik-pp-cli events volume-list- Get event volume for specified filters and timeframe
flows
Manage flows
authentik-pp-cli flows bindings-create- FlowStageBinding Viewsetauthentik-pp-cli flows bindings-destroy- FlowStageBinding Viewsetauthentik-pp-cli flows bindings-list- FlowStageBinding Viewsetauthentik-pp-cli flows bindings-partial-update- FlowStageBinding Viewsetauthentik-pp-cli flows bindings-retrieve- FlowStageBinding Viewsetauthentik-pp-cli flows bindings-update- FlowStageBinding Viewsetauthentik-pp-cli flows bindings-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli flows executor-get- Get the next pending challenge from the currently active flow.authentik-pp-cli flows executor-solve- Solve the previously retrieved challenge and advanced to the next stage.authentik-pp-cli flows inspector-get- Get current flow state and record itauthentik-pp-cli flows instances-cache-clear-create- Clear flow cacheauthentik-pp-cli flows instances-cache-info-retrieve- Info about cached flowsauthentik-pp-cli flows instances-create- Flow Viewsetauthentik-pp-cli flows instances-destroy- Flow Viewsetauthentik-pp-cli flows instances-diagram-retrieve- Return diagram for flow with slugslug, in the format used by flowchart.jsauthentik-pp-cli flows instances-execute-retrieve- Execute flow for current userauthentik-pp-cli flows instances-export-retrieve- Export flow to .yaml fileauthentik-pp-cli flows instances-import-create- Import flow from .yaml fileauthentik-pp-cli flows instances-list- Flow Viewsetauthentik-pp-cli flows instances-partial-update- Flow Viewsetauthentik-pp-cli flows instances-retrieve- Flow Viewsetauthentik-pp-cli flows instances-set-background-create- Set Flow backgroundauthentik-pp-cli flows instances-set-background-url-create- Set Flow background (as URL)authentik-pp-cli flows instances-update- Flow Viewsetauthentik-pp-cli flows instances-used-by-list- Get a list of all objects that use this object
oauth2
Manage oauth2
authentik-pp-cli oauth2 access-tokens-destroy- AccessToken Viewsetauthentik-pp-cli oauth2 access-tokens-list- AccessToken Viewsetauthentik-pp-cli oauth2 access-tokens-retrieve- AccessToken Viewsetauthentik-pp-cli oauth2 access-tokens-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli oauth2 authorization-codes-destroy- AuthorizationCode Viewsetauthentik-pp-cli oauth2 authorization-codes-list- AuthorizationCode Viewsetauthentik-pp-cli oauth2 authorization-codes-retrieve- AuthorizationCode Viewsetauthentik-pp-cli oauth2 authorization-codes-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli oauth2 refresh-tokens-destroy- RefreshToken Viewsetauthentik-pp-cli oauth2 refresh-tokens-list- RefreshToken Viewsetauthentik-pp-cli oauth2 refresh-tokens-retrieve- RefreshToken Viewsetauthentik-pp-cli oauth2 refresh-tokens-used-by-list- Get a list of all objects that use this object
policies
Manage policies
authentik-pp-cli policies all-cache-clear-create- Clear policy cacheauthentik-pp-cli policies all-cache-info-retrieve- Info about cached policiesauthentik-pp-cli policies all-destroy- Policy Viewsetauthentik-pp-cli policies all-list- Policy Viewsetauthentik-pp-cli policies all-retrieve- Policy Viewsetauthentik-pp-cli policies all-test-create- Test policyauthentik-pp-cli policies all-types-list- Get all creatable typesauthentik-pp-cli policies all-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies bindings-create- PolicyBinding Viewsetauthentik-pp-cli policies bindings-destroy- PolicyBinding Viewsetauthentik-pp-cli policies bindings-list- PolicyBinding Viewsetauthentik-pp-cli policies bindings-partial-update- PolicyBinding Viewsetauthentik-pp-cli policies bindings-retrieve- PolicyBinding Viewsetauthentik-pp-cli policies bindings-update- PolicyBinding Viewsetauthentik-pp-cli policies bindings-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies dummy-create- Dummy Viewsetauthentik-pp-cli policies dummy-destroy- Dummy Viewsetauthentik-pp-cli policies dummy-list- Dummy Viewsetauthentik-pp-cli policies dummy-partial-update- Dummy Viewsetauthentik-pp-cli policies dummy-retrieve- Dummy Viewsetauthentik-pp-cli policies dummy-update- Dummy Viewsetauthentik-pp-cli policies dummy-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies event-matcher-create- Event Matcher Policy Viewsetauthentik-pp-cli policies event-matcher-destroy- Event Matcher Policy Viewsetauthentik-pp-cli policies event-matcher-list- Event Matcher Policy Viewsetauthentik-pp-cli policies event-matcher-partial-update- Event Matcher Policy Viewsetauthentik-pp-cli policies event-matcher-retrieve- Event Matcher Policy Viewsetauthentik-pp-cli policies event-matcher-update- Event Matcher Policy Viewsetauthentik-pp-cli policies event-matcher-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies expression-create- Source Viewsetauthentik-pp-cli policies expression-destroy- Source Viewsetauthentik-pp-cli policies expression-list- Source Viewsetauthentik-pp-cli policies expression-partial-update- Source Viewsetauthentik-pp-cli policies expression-retrieve- Source Viewsetauthentik-pp-cli policies expression-update- Source Viewsetauthentik-pp-cli policies expression-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies geoip-create- GeoIP Viewsetauthentik-pp-cli policies geoip-destroy- GeoIP Viewsetauthentik-pp-cli policies geoip-iso3166-list- Get all countries in ISO-3166-1authentik-pp-cli policies geoip-list- GeoIP Viewsetauthentik-pp-cli policies geoip-partial-update- GeoIP Viewsetauthentik-pp-cli policies geoip-retrieve- GeoIP Viewsetauthentik-pp-cli policies geoip-update- GeoIP Viewsetauthentik-pp-cli policies geoip-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies password-create- Password Policy Viewsetauthentik-pp-cli policies password-destroy- Password Policy Viewsetauthentik-pp-cli policies password-expiry-create- Password Expiry Viewsetauthentik-pp-cli policies password-expiry-destroy- Password Expiry Viewsetauthentik-pp-cli policies password-expiry-list- Password Expiry Viewsetauthentik-pp-cli policies password-expiry-partial-update- Password Expiry Viewsetauthentik-pp-cli policies password-expiry-retrieve- Password Expiry Viewsetauthentik-pp-cli policies password-expiry-update- Password Expiry Viewsetauthentik-pp-cli policies password-expiry-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies password-list- Password Policy Viewsetauthentik-pp-cli policies password-partial-update- Password Policy Viewsetauthentik-pp-cli policies password-retrieve- Password Policy Viewsetauthentik-pp-cli policies password-update- Password Policy Viewsetauthentik-pp-cli policies password-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies reputation-create- Reputation Policy Viewsetauthentik-pp-cli policies reputation-destroy- Reputation Policy Viewsetauthentik-pp-cli policies reputation-list- Reputation Policy Viewsetauthentik-pp-cli policies reputation-partial-update- Reputation Policy Viewsetauthentik-pp-cli policies reputation-retrieve- Reputation Policy Viewsetauthentik-pp-cli policies reputation-scores-destroy- Reputation Viewsetauthentik-pp-cli policies reputation-scores-list- Reputation Viewsetauthentik-pp-cli policies reputation-scores-retrieve- Reputation Viewsetauthentik-pp-cli policies reputation-scores-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies reputation-update- Reputation Policy Viewsetauthentik-pp-cli policies reputation-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli policies unique-password-create- Password Uniqueness Policy Viewsetauthentik-pp-cli policies unique-password-destroy- Password Uniqueness Policy Viewsetauthentik-pp-cli policies unique-password-list- Password Uniqueness Policy Viewsetauthentik-pp-cli policies unique-password-partial-update- Password Uniqueness Policy Viewsetauthentik-pp-cli policies unique-password-retrieve- Password Uniqueness Policy Viewsetauthentik-pp-cli policies unique-password-update- Password Uniqueness Policy Viewsetauthentik-pp-cli policies unique-password-used-by-list- Get a list of all objects that use this object
propertymappings
Manage propertymappings
authentik-pp-cli propertymappings all-destroy- PropertyMapping Viewsetauthentik-pp-cli propertymappings all-list- PropertyMapping Viewsetauthentik-pp-cli propertymappings all-retrieve- PropertyMapping Viewsetauthentik-pp-cli propertymappings all-test-create- Test Property Mappingauthentik-pp-cli propertymappings all-types-list- Get all creatable typesauthentik-pp-cli propertymappings all-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings notification-create- NotificationWebhookMapping Viewsetauthentik-pp-cli propertymappings notification-destroy- NotificationWebhookMapping Viewsetauthentik-pp-cli propertymappings notification-list- NotificationWebhookMapping Viewsetauthentik-pp-cli propertymappings notification-partial-update- NotificationWebhookMapping Viewsetauthentik-pp-cli propertymappings notification-retrieve- NotificationWebhookMapping Viewsetauthentik-pp-cli propertymappings notification-update- NotificationWebhookMapping Viewsetauthentik-pp-cli propertymappings notification-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings provider-google-workspace-create- GoogleWorkspaceProviderMapping Viewsetauthentik-pp-cli propertymappings provider-google-workspace-destroy- GoogleWorkspaceProviderMapping Viewsetauthentik-pp-cli propertymappings provider-google-workspace-list- GoogleWorkspaceProviderMapping Viewsetauthentik-pp-cli propertymappings provider-google-workspace-partial-update- GoogleWorkspaceProviderMapping Viewsetauthentik-pp-cli propertymappings provider-google-workspace-retrieve- GoogleWorkspaceProviderMapping Viewsetauthentik-pp-cli propertymappings provider-google-workspace-update- GoogleWorkspaceProviderMapping Viewsetauthentik-pp-cli propertymappings provider-google-workspace-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings provider-microsoft-entra-create- MicrosoftEntraProviderMapping Viewsetauthentik-pp-cli propertymappings provider-microsoft-entra-destroy- MicrosoftEntraProviderMapping Viewsetauthentik-pp-cli propertymappings provider-microsoft-entra-list- MicrosoftEntraProviderMapping Viewsetauthentik-pp-cli propertymappings provider-microsoft-entra-partial-update- MicrosoftEntraProviderMapping Viewsetauthentik-pp-cli propertymappings provider-microsoft-entra-retrieve- MicrosoftEntraProviderMapping Viewsetauthentik-pp-cli propertymappings provider-microsoft-entra-update- MicrosoftEntraProviderMapping Viewsetauthentik-pp-cli propertymappings provider-microsoft-entra-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings provider-rac-create- RACPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-rac-destroy- RACPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-rac-list- RACPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-rac-partial-update- RACPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-rac-retrieve- RACPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-rac-update- RACPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-rac-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings provider-radius-create- RadiusProviderPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-radius-destroy- RadiusProviderPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-radius-list- RadiusProviderPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-radius-partial-update- RadiusProviderPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-radius-retrieve- RadiusProviderPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-radius-update- RadiusProviderPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-radius-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings provider-saml-create- SAMLPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-saml-destroy- SAMLPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-saml-list- SAMLPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-saml-partial-update- SAMLPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-saml-retrieve- SAMLPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-saml-update- SAMLPropertyMapping Viewsetauthentik-pp-cli propertymappings provider-saml-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings provider-scim-create- SCIMMapping Viewsetauthentik-pp-cli propertymappings provider-scim-destroy- SCIMMapping Viewsetauthentik-pp-cli propertymappings provider-scim-list- SCIMMapping Viewsetauthentik-pp-cli propertymappings provider-scim-partial-update- SCIMMapping Viewsetauthentik-pp-cli propertymappings provider-scim-retrieve- SCIMMapping Viewsetauthentik-pp-cli propertymappings provider-scim-update- SCIMMapping Viewsetauthentik-pp-cli propertymappings provider-scim-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings provider-scope-create- ScopeMapping Viewsetauthentik-pp-cli propertymappings provider-scope-destroy- ScopeMapping Viewsetauthentik-pp-cli propertymappings provider-scope-list- ScopeMapping Viewsetauthentik-pp-cli propertymappings provider-scope-partial-update- ScopeMapping Viewsetauthentik-pp-cli propertymappings provider-scope-retrieve- ScopeMapping Viewsetauthentik-pp-cli propertymappings provider-scope-update- ScopeMapping Viewsetauthentik-pp-cli propertymappings provider-scope-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings source-kerberos-create- KerberosSource PropertyMapping Viewsetauthentik-pp-cli propertymappings source-kerberos-destroy- KerberosSource PropertyMapping Viewsetauthentik-pp-cli propertymappings source-kerberos-list- KerberosSource PropertyMapping Viewsetauthentik-pp-cli propertymappings source-kerberos-partial-update- KerberosSource PropertyMapping Viewsetauthentik-pp-cli propertymappings source-kerberos-retrieve- KerberosSource PropertyMapping Viewsetauthentik-pp-cli propertymappings source-kerberos-update- KerberosSource PropertyMapping Viewsetauthentik-pp-cli propertymappings source-kerberos-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings source-ldap-create- LDAP PropertyMapping Viewsetauthentik-pp-cli propertymappings source-ldap-destroy- LDAP PropertyMapping Viewsetauthentik-pp-cli propertymappings source-ldap-list- LDAP PropertyMapping Viewsetauthentik-pp-cli propertymappings source-ldap-partial-update- LDAP PropertyMapping Viewsetauthentik-pp-cli propertymappings source-ldap-retrieve- LDAP PropertyMapping Viewsetauthentik-pp-cli propertymappings source-ldap-update- LDAP PropertyMapping Viewsetauthentik-pp-cli propertymappings source-ldap-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings source-oauth-create- OAuthSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-oauth-destroy- OAuthSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-oauth-list- OAuthSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-oauth-partial-update- OAuthSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-oauth-retrieve- OAuthSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-oauth-update- OAuthSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-oauth-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings source-plex-create- PlexSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-plex-destroy- PlexSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-plex-list- PlexSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-plex-partial-update- PlexSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-plex-retrieve- PlexSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-plex-update- PlexSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-plex-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings source-saml-create- SAMLSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-saml-destroy- SAMLSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-saml-list- SAMLSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-saml-partial-update- SAMLSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-saml-retrieve- SAMLSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-saml-update- SAMLSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-saml-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings source-scim-create- SCIMSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-scim-destroy- SCIMSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-scim-list- SCIMSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-scim-partial-update- SCIMSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-scim-retrieve- SCIMSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-scim-update- SCIMSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-scim-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli propertymappings source-telegram-create- TelegramSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-telegram-destroy- TelegramSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-telegram-list- TelegramSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-telegram-partial-update- TelegramSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-telegram-retrieve- TelegramSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-telegram-update- TelegramSourcePropertyMapping Viewsetauthentik-pp-cli propertymappings source-telegram-used-by-list- Get a list of all objects that use this object
providers
Manage providers
authentik-pp-cli providers all-destroy- Provider Viewsetauthentik-pp-cli providers all-list- Provider Viewsetauthentik-pp-cli providers all-retrieve- Provider Viewsetauthentik-pp-cli providers all-types-list- Get all creatable typesauthentik-pp-cli providers all-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers google-workspace-create- GoogleWorkspaceProvider Viewsetauthentik-pp-cli providers google-workspace-destroy- GoogleWorkspaceProvider Viewsetauthentik-pp-cli providers google-workspace-groups-create- GoogleWorkspaceProviderGroup Viewsetauthentik-pp-cli providers google-workspace-groups-destroy- GoogleWorkspaceProviderGroup Viewsetauthentik-pp-cli providers google-workspace-groups-list- GoogleWorkspaceProviderGroup Viewsetauthentik-pp-cli providers google-workspace-groups-retrieve- GoogleWorkspaceProviderGroup Viewsetauthentik-pp-cli providers google-workspace-groups-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers google-workspace-list- GoogleWorkspaceProvider Viewsetauthentik-pp-cli providers google-workspace-partial-update- GoogleWorkspaceProvider Viewsetauthentik-pp-cli providers google-workspace-retrieve- GoogleWorkspaceProvider Viewsetauthentik-pp-cli providers google-workspace-sync-object-create- Sync/Re-sync a single user/group objectauthentik-pp-cli providers google-workspace-sync-status-retrieve- Get provider's sync statusauthentik-pp-cli providers google-workspace-update- GoogleWorkspaceProvider Viewsetauthentik-pp-cli providers google-workspace-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers google-workspace-users-create- GoogleWorkspaceProviderUser Viewsetauthentik-pp-cli providers google-workspace-users-destroy- GoogleWorkspaceProviderUser Viewsetauthentik-pp-cli providers google-workspace-users-list- GoogleWorkspaceProviderUser Viewsetauthentik-pp-cli providers google-workspace-users-retrieve- GoogleWorkspaceProviderUser Viewsetauthentik-pp-cli providers google-workspace-users-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers ldap-create- LDAPProvider Viewsetauthentik-pp-cli providers ldap-destroy- LDAPProvider Viewsetauthentik-pp-cli providers ldap-list- LDAPProvider Viewsetauthentik-pp-cli providers ldap-partial-update- LDAPProvider Viewsetauthentik-pp-cli providers ldap-retrieve- LDAPProvider Viewsetauthentik-pp-cli providers ldap-update- LDAPProvider Viewsetauthentik-pp-cli providers ldap-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers microsoft-entra-create- MicrosoftEntraProvider Viewsetauthentik-pp-cli providers microsoft-entra-destroy- MicrosoftEntraProvider Viewsetauthentik-pp-cli providers microsoft-entra-groups-create- MicrosoftEntraProviderGroup Viewsetauthentik-pp-cli providers microsoft-entra-groups-destroy- MicrosoftEntraProviderGroup Viewsetauthentik-pp-cli providers microsoft-entra-groups-list- MicrosoftEntraProviderGroup Viewsetauthentik-pp-cli providers microsoft-entra-groups-retrieve- MicrosoftEntraProviderGroup Viewsetauthentik-pp-cli providers microsoft-entra-groups-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers microsoft-entra-list- MicrosoftEntraProvider Viewsetauthentik-pp-cli providers microsoft-entra-partial-update- MicrosoftEntraProvider Viewsetauthentik-pp-cli providers microsoft-entra-retrieve- MicrosoftEntraProvider Viewsetauthentik-pp-cli providers microsoft-entra-sync-object-create- Sync/Re-sync a single user/group objectauthentik-pp-cli providers microsoft-entra-sync-status-retrieve- Get provider's sync statusauthentik-pp-cli providers microsoft-entra-update- MicrosoftEntraProvider Viewsetauthentik-pp-cli providers microsoft-entra-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers microsoft-entra-users-create- MicrosoftEntraProviderUser Viewsetauthentik-pp-cli providers microsoft-entra-users-destroy- MicrosoftEntraProviderUser Viewsetauthentik-pp-cli providers microsoft-entra-users-list- MicrosoftEntraProviderUser Viewsetauthentik-pp-cli providers microsoft-entra-users-retrieve- MicrosoftEntraProviderUser Viewsetauthentik-pp-cli providers microsoft-entra-users-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers oauth2-create- OAuth2Provider Viewsetauthentik-pp-cli providers oauth2-destroy- OAuth2Provider Viewsetauthentik-pp-cli providers oauth2-list- OAuth2Provider Viewsetauthentik-pp-cli providers oauth2-partial-update- OAuth2Provider Viewsetauthentik-pp-cli providers oauth2-preview-user-retrieve- Preview user data for providerauthentik-pp-cli providers oauth2-retrieve- OAuth2Provider Viewsetauthentik-pp-cli providers oauth2-setup-urls-retrieve- Get Providers setup URLsauthentik-pp-cli providers oauth2-update- OAuth2Provider Viewsetauthentik-pp-cli providers oauth2-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers proxy-create- ProxyProvider Viewsetauthentik-pp-cli providers proxy-destroy- ProxyProvider Viewsetauthentik-pp-cli providers proxy-list- ProxyProvider Viewsetauthentik-pp-cli providers proxy-partial-update- ProxyProvider Viewsetauthentik-pp-cli providers proxy-retrieve- ProxyProvider Viewsetauthentik-pp-cli providers proxy-update- ProxyProvider Viewsetauthentik-pp-cli providers proxy-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers rac-create- RACProvider Viewsetauthentik-pp-cli providers rac-destroy- RACProvider Viewsetauthentik-pp-cli providers rac-list- RACProvider Viewsetauthentik-pp-cli providers rac-partial-update- RACProvider Viewsetauthentik-pp-cli providers rac-retrieve- RACProvider Viewsetauthentik-pp-cli providers rac-update- RACProvider Viewsetauthentik-pp-cli providers rac-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers radius-create- RadiusProvider Viewsetauthentik-pp-cli providers radius-destroy- RadiusProvider Viewsetauthentik-pp-cli providers radius-list- RadiusProvider Viewsetauthentik-pp-cli providers radius-partial-update- RadiusProvider Viewsetauthentik-pp-cli providers radius-retrieve- RadiusProvider Viewsetauthentik-pp-cli providers radius-update- RadiusProvider Viewsetauthentik-pp-cli providers radius-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers saml-create- SAMLProvider Viewsetauthentik-pp-cli providers saml-destroy- SAMLProvider Viewsetauthentik-pp-cli providers saml-import-metadata-create- Create provider from SAML Metadataauthentik-pp-cli providers saml-list- SAMLProvider Viewsetauthentik-pp-cli providers saml-metadata-retrieve- Return metadata as XML stringauthentik-pp-cli providers saml-partial-update- SAMLProvider Viewsetauthentik-pp-cli providers saml-preview-user-retrieve- Preview user data for providerauthentik-pp-cli providers saml-retrieve- SAMLProvider Viewsetauthentik-pp-cli providers saml-update- SAMLProvider Viewsetauthentik-pp-cli providers saml-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers scim-create- SCIMProvider Viewsetauthentik-pp-cli providers scim-destroy- SCIMProvider Viewsetauthentik-pp-cli providers scim-groups-create- SCIMProviderGroup Viewsetauthentik-pp-cli providers scim-groups-destroy- SCIMProviderGroup Viewsetauthentik-pp-cli providers scim-groups-list- SCIMProviderGroup Viewsetauthentik-pp-cli providers scim-groups-retrieve- SCIMProviderGroup Viewsetauthentik-pp-cli providers scim-groups-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers scim-list- SCIMProvider Viewsetauthentik-pp-cli providers scim-partial-update- SCIMProvider Viewsetauthentik-pp-cli providers scim-retrieve- SCIMProvider Viewsetauthentik-pp-cli providers scim-sync-object-create- Sync/Re-sync a single user/group objectauthentik-pp-cli providers scim-sync-status-retrieve- Get provider's sync statusauthentik-pp-cli providers scim-update- SCIMProvider Viewsetauthentik-pp-cli providers scim-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers scim-users-create- SCIMProviderUser Viewsetauthentik-pp-cli providers scim-users-destroy- SCIMProviderUser Viewsetauthentik-pp-cli providers scim-users-list- SCIMProviderUser Viewsetauthentik-pp-cli providers scim-users-retrieve- SCIMProviderUser Viewsetauthentik-pp-cli providers scim-users-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli providers ssf-create- SSFProvider Viewsetauthentik-pp-cli providers ssf-destroy- SSFProvider Viewsetauthentik-pp-cli providers ssf-list- SSFProvider Viewsetauthentik-pp-cli providers ssf-partial-update- SSFProvider Viewsetauthentik-pp-cli providers ssf-retrieve- SSFProvider Viewsetauthentik-pp-cli providers ssf-update- SSFProvider Viewsetauthentik-pp-cli providers ssf-used-by-list- Get a list of all objects that use this object
rac
Manage rac
authentik-pp-cli rac connection-tokens-destroy- ConnectionToken Viewsetauthentik-pp-cli rac connection-tokens-list- ConnectionToken Viewsetauthentik-pp-cli rac connection-tokens-partial-update- ConnectionToken Viewsetauthentik-pp-cli rac connection-tokens-retrieve- ConnectionToken Viewsetauthentik-pp-cli rac connection-tokens-update- ConnectionToken Viewsetauthentik-pp-cli rac connection-tokens-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli rac endpoints-create- Endpoint Viewsetauthentik-pp-cli rac endpoints-destroy- Endpoint Viewsetauthentik-pp-cli rac endpoints-list- List accessible endpointsauthentik-pp-cli rac endpoints-partial-update- Endpoint Viewsetauthentik-pp-cli rac endpoints-retrieve- Endpoint Viewsetauthentik-pp-cli rac endpoints-update- Endpoint Viewsetauthentik-pp-cli rac endpoints-used-by-list- Get a list of all objects that use this object
rbac
Manage rbac
authentik-pp-cli rbac initial-permissions-create- InitialPermissions viewsetauthentik-pp-cli rbac initial-permissions-destroy- InitialPermissions viewsetauthentik-pp-cli rbac initial-permissions-list- InitialPermissions viewsetauthentik-pp-cli rbac initial-permissions-partial-update- InitialPermissions viewsetauthentik-pp-cli rbac initial-permissions-retrieve- InitialPermissions viewsetauthentik-pp-cli rbac initial-permissions-update- InitialPermissions viewsetauthentik-pp-cli rbac initial-permissions-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli rbac permissions-assigned-by-roles-assign- Assign permission(s) to role. Whenobject_pkis set, the permissions are only assigned to the specific object, otherwise they are assigned globally.authentik-pp-cli rbac permissions-assigned-by-roles-list- Get assigned object permissions for a single objectauthentik-pp-cli rbac permissions-assigned-by-roles-unassign-partial-update- Unassign permission(s) to role. Whenobject_pkis set, the permissions are only assigned to the specific object, otherwise they are assigned globally.authentik-pp-cli rbac permissions-assigned-by-users-assign- Assign permission(s) to userauthentik-pp-cli rbac permissions-assigned-by-users-list- Get assigned object permissions for a single objectauthentik-pp-cli rbac permissions-assigned-by-users-unassign-partial-update- Unassign permission(s) to user. Whenobject_pkis set, the permissions are only assigned to the specific object, otherwise they are assigned globally.authentik-pp-cli rbac permissions-list- Read-only list of all permissions, filterable by model and appauthentik-pp-cli rbac permissions-retrieve- Read-only list of all permissions, filterable by model and appauthentik-pp-cli rbac permissions-roles-destroy- Get a role's assigned object permissionsauthentik-pp-cli rbac permissions-roles-list- Get a role's assigned object permissionsauthentik-pp-cli rbac permissions-roles-partial-update- Get a role's assigned object permissionsauthentik-pp-cli rbac permissions-roles-retrieve- Get a role's assigned object permissionsauthentik-pp-cli rbac permissions-roles-update- Get a role's assigned object permissionsauthentik-pp-cli rbac permissions-users-destroy- Get a users's assigned object permissionsauthentik-pp-cli rbac permissions-users-list- Get a users's assigned object permissionsauthentik-pp-cli rbac permissions-users-partial-update- Get a users's assigned object permissionsauthentik-pp-cli rbac permissions-users-retrieve- Get a users's assigned object permissionsauthentik-pp-cli rbac permissions-users-update- Get a users's assigned object permissionsauthentik-pp-cli rbac roles-create- Role viewsetauthentik-pp-cli rbac roles-destroy- Role viewsetauthentik-pp-cli rbac roles-list- Role viewsetauthentik-pp-cli rbac roles-partial-update- Role viewsetauthentik-pp-cli rbac roles-retrieve- Role viewsetauthentik-pp-cli rbac roles-update- Role viewsetauthentik-pp-cli rbac roles-used-by-list- Get a list of all objects that use this object
root
Manage root
authentik-pp-cli root- Retrieve public configuration options
schema
Manage schema
-
authentik-pp-cli schema- OpenApi3 schema for this API. Format can be selected via content negotiation. -
YAML: application/vnd.oai.openapi
-
JSON: application/vnd.oai.openapi+json
sources
Manage sources
authentik-pp-cli sources all-destroy- Prevent deletion of built-in sourcesauthentik-pp-cli sources all-list- Source Viewsetauthentik-pp-cli sources all-retrieve- Source Viewsetauthentik-pp-cli sources all-set-icon-create- Set source iconauthentik-pp-cli sources all-set-icon-url-create- Set source icon (as URL)authentik-pp-cli sources all-types-list- Get all creatable typesauthentik-pp-cli sources all-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources all-user-settings-list- Get all sources the user can configureauthentik-pp-cli sources group-connections-all-destroy- Group-source connection Viewsetauthentik-pp-cli sources group-connections-all-list- Group-source connection Viewsetauthentik-pp-cli sources group-connections-all-partial-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-all-retrieve- Group-source connection Viewsetauthentik-pp-cli sources group-connections-all-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-all-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources group-connections-kerberos-create- Group-source connection Viewsetauthentik-pp-cli sources group-connections-kerberos-destroy- Group-source connection Viewsetauthentik-pp-cli sources group-connections-kerberos-list- Group-source connection Viewsetauthentik-pp-cli sources group-connections-kerberos-partial-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-kerberos-retrieve- Group-source connection Viewsetauthentik-pp-cli sources group-connections-kerberos-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-kerberos-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources group-connections-ldap-create- Group-source connection Viewsetauthentik-pp-cli sources group-connections-ldap-destroy- Group-source connection Viewsetauthentik-pp-cli sources group-connections-ldap-list- Group-source connection Viewsetauthentik-pp-cli sources group-connections-ldap-partial-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-ldap-retrieve- Group-source connection Viewsetauthentik-pp-cli sources group-connections-ldap-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-ldap-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources group-connections-oauth-create- Group-source connection Viewsetauthentik-pp-cli sources group-connections-oauth-destroy- Group-source connection Viewsetauthentik-pp-cli sources group-connections-oauth-list- Group-source connection Viewsetauthentik-pp-cli sources group-connections-oauth-partial-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-oauth-retrieve- Group-source connection Viewsetauthentik-pp-cli sources group-connections-oauth-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-oauth-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources group-connections-plex-create- Group-source connection Viewsetauthentik-pp-cli sources group-connections-plex-destroy- Group-source connection Viewsetauthentik-pp-cli sources group-connections-plex-list- Group-source connection Viewsetauthentik-pp-cli sources group-connections-plex-partial-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-plex-retrieve- Group-source connection Viewsetauthentik-pp-cli sources group-connections-plex-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-plex-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources group-connections-saml-create- Group-source connection Viewsetauthentik-pp-cli sources group-connections-saml-destroy- Group-source connection Viewsetauthentik-pp-cli sources group-connections-saml-list- Group-source connection Viewsetauthentik-pp-cli sources group-connections-saml-partial-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-saml-retrieve- Group-source connection Viewsetauthentik-pp-cli sources group-connections-saml-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-saml-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources group-connections-telegram-create- Group-source connection Viewsetauthentik-pp-cli sources group-connections-telegram-destroy- Group-source connection Viewsetauthentik-pp-cli sources group-connections-telegram-list- Group-source connection Viewsetauthentik-pp-cli sources group-connections-telegram-partial-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-telegram-retrieve- Group-source connection Viewsetauthentik-pp-cli sources group-connections-telegram-update- Group-source connection Viewsetauthentik-pp-cli sources group-connections-telegram-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources kerberos-create- Kerberos Source Viewsetauthentik-pp-cli sources kerberos-destroy- Kerberos Source Viewsetauthentik-pp-cli sources kerberos-list- Kerberos Source Viewsetauthentik-pp-cli sources kerberos-partial-update- Kerberos Source Viewsetauthentik-pp-cli sources kerberos-retrieve- Kerberos Source Viewsetauthentik-pp-cli sources kerberos-sync-status-retrieve- Get provider's sync statusauthentik-pp-cli sources kerberos-update- Kerberos Source Viewsetauthentik-pp-cli sources kerberos-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources ldap-create- LDAP Source Viewsetauthentik-pp-cli sources ldap-debug-retrieve- Get raw LDAP data to debugauthentik-pp-cli sources ldap-destroy- LDAP Source Viewsetauthentik-pp-cli sources ldap-list- LDAP Source Viewsetauthentik-pp-cli sources ldap-partial-update- LDAP Source Viewsetauthentik-pp-cli sources ldap-retrieve- LDAP Source Viewsetauthentik-pp-cli sources ldap-sync-status-retrieve- Get provider's sync statusauthentik-pp-cli sources ldap-update- LDAP Source Viewsetauthentik-pp-cli sources ldap-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources oauth-create- Source Viewsetauthentik-pp-cli sources oauth-destroy- Source Viewsetauthentik-pp-cli sources oauth-list- Source Viewsetauthentik-pp-cli sources oauth-partial-update- Source Viewsetauthentik-pp-cli sources oauth-retrieve- Source Viewsetauthentik-pp-cli sources oauth-types-list- Get all creatable source types. If ?name is set, only returns the type for . If isn't found, returns the default type.authentik-pp-cli sources oauth-update- Source Viewsetauthentik-pp-cli sources oauth-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources plex-create- Plex source Viewsetauthentik-pp-cli sources plex-destroy- Plex source Viewsetauthentik-pp-cli sources plex-list- Plex source Viewsetauthentik-pp-cli sources plex-partial-update- Plex source Viewsetauthentik-pp-cli sources plex-redeem-token-authenticated-create- Redeem a plex token for an authenticated user, creating a connectionauthentik-pp-cli sources plex-redeem-token-create- Redeem a plex token, check it's access to resources against what's allowed for the source, and redirect to an authentication/enrollment flow.authentik-pp-cli sources plex-retrieve- Plex source Viewsetauthentik-pp-cli sources plex-update- Plex source Viewsetauthentik-pp-cli sources plex-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources saml-create- SAMLSource Viewsetauthentik-pp-cli sources saml-destroy- SAMLSource Viewsetauthentik-pp-cli sources saml-list- SAMLSource Viewsetauthentik-pp-cli sources saml-metadata-retrieve- Return metadata as XML stringauthentik-pp-cli sources saml-partial-update- SAMLSource Viewsetauthentik-pp-cli sources saml-retrieve- SAMLSource Viewsetauthentik-pp-cli sources saml-update- SAMLSource Viewsetauthentik-pp-cli sources saml-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources scim-create- SCIMSource Viewsetauthentik-pp-cli sources scim-destroy- SCIMSource Viewsetauthentik-pp-cli sources scim-groups-create- SCIMSourceGroup Viewsetauthentik-pp-cli sources scim-groups-destroy- SCIMSourceGroup Viewsetauthentik-pp-cli sources scim-groups-list- SCIMSourceGroup Viewsetauthentik-pp-cli sources scim-groups-partial-update- SCIMSourceGroup Viewsetauthentik-pp-cli sources scim-groups-retrieve- SCIMSourceGroup Viewsetauthentik-pp-cli sources scim-groups-update- SCIMSourceGroup Viewsetauthentik-pp-cli sources scim-groups-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources scim-list- SCIMSource Viewsetauthentik-pp-cli sources scim-partial-update- SCIMSource Viewsetauthentik-pp-cli sources scim-retrieve- SCIMSource Viewsetauthentik-pp-cli sources scim-update- SCIMSource Viewsetauthentik-pp-cli sources scim-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources scim-users-create- SCIMSourceUser Viewsetauthentik-pp-cli sources scim-users-destroy- SCIMSourceUser Viewsetauthentik-pp-cli sources scim-users-list- SCIMSourceUser Viewsetauthentik-pp-cli sources scim-users-partial-update- SCIMSourceUser Viewsetauthentik-pp-cli sources scim-users-retrieve- SCIMSourceUser Viewsetauthentik-pp-cli sources scim-users-update- SCIMSourceUser Viewsetauthentik-pp-cli sources scim-users-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources telegram-create- Mixin to add a used_by endpoint to return a list of all objects using this objectauthentik-pp-cli sources telegram-destroy- Mixin to add a used_by endpoint to return a list of all objects using this objectauthentik-pp-cli sources telegram-list- Mixin to add a used_by endpoint to return a list of all objects using this objectauthentik-pp-cli sources telegram-partial-update- Mixin to add a used_by endpoint to return a list of all objects using this objectauthentik-pp-cli sources telegram-retrieve- Mixin to add a used_by endpoint to return a list of all objects using this objectauthentik-pp-cli sources telegram-update- Mixin to add a used_by endpoint to return a list of all objects using this objectauthentik-pp-cli sources telegram-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources user-connections-all-destroy- User-source connection Viewsetauthentik-pp-cli sources user-connections-all-list- User-source connection Viewsetauthentik-pp-cli sources user-connections-all-partial-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-all-retrieve- User-source connection Viewsetauthentik-pp-cli sources user-connections-all-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-all-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources user-connections-kerberos-create- User-source connection Viewsetauthentik-pp-cli sources user-connections-kerberos-destroy- User-source connection Viewsetauthentik-pp-cli sources user-connections-kerberos-list- User-source connection Viewsetauthentik-pp-cli sources user-connections-kerberos-partial-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-kerberos-retrieve- User-source connection Viewsetauthentik-pp-cli sources user-connections-kerberos-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-kerberos-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources user-connections-ldap-create- User-source connection Viewsetauthentik-pp-cli sources user-connections-ldap-destroy- User-source connection Viewsetauthentik-pp-cli sources user-connections-ldap-list- User-source connection Viewsetauthentik-pp-cli sources user-connections-ldap-partial-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-ldap-retrieve- User-source connection Viewsetauthentik-pp-cli sources user-connections-ldap-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-ldap-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources user-connections-oauth-create- User-source connection Viewsetauthentik-pp-cli sources user-connections-oauth-destroy- User-source connection Viewsetauthentik-pp-cli sources user-connections-oauth-list- User-source connection Viewsetauthentik-pp-cli sources user-connections-oauth-partial-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-oauth-retrieve- User-source connection Viewsetauthentik-pp-cli sources user-connections-oauth-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-oauth-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources user-connections-plex-create- User-source connection Viewsetauthentik-pp-cli sources user-connections-plex-destroy- User-source connection Viewsetauthentik-pp-cli sources user-connections-plex-list- User-source connection Viewsetauthentik-pp-cli sources user-connections-plex-partial-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-plex-retrieve- User-source connection Viewsetauthentik-pp-cli sources user-connections-plex-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-plex-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources user-connections-saml-create- User-source connection Viewsetauthentik-pp-cli sources user-connections-saml-destroy- User-source connection Viewsetauthentik-pp-cli sources user-connections-saml-list- User-source connection Viewsetauthentik-pp-cli sources user-connections-saml-partial-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-saml-retrieve- User-source connection Viewsetauthentik-pp-cli sources user-connections-saml-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-saml-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli sources user-connections-telegram-create- User-source connection Viewsetauthentik-pp-cli sources user-connections-telegram-destroy- User-source connection Viewsetauthentik-pp-cli sources user-connections-telegram-list- User-source connection Viewsetauthentik-pp-cli sources user-connections-telegram-partial-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-telegram-retrieve- User-source connection Viewsetauthentik-pp-cli sources user-connections-telegram-update- User-source connection Viewsetauthentik-pp-cli sources user-connections-telegram-used-by-list- Get a list of all objects that use this object
ssf
Manage ssf
authentik-pp-cli ssf streams-list- SSFStream Viewsetauthentik-pp-cli ssf streams-retrieve- SSFStream Viewset
stages
Manage stages
authentik-pp-cli stages all-destroy- Stage Viewsetauthentik-pp-cli stages all-list- Stage Viewsetauthentik-pp-cli stages all-retrieve- Stage Viewsetauthentik-pp-cli stages all-types-list- Get all creatable typesauthentik-pp-cli stages all-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages all-user-settings-list- Get all stages the user can configureauthentik-pp-cli stages authenticator-duo-create- AuthenticatorDuoStage Viewsetauthentik-pp-cli stages authenticator-duo-destroy- AuthenticatorDuoStage Viewsetauthentik-pp-cli stages authenticator-duo-enrollment-status-create- Check enrollment status of user details in current sessionauthentik-pp-cli stages authenticator-duo-import-device-manual-create- Import duo devices into authentikauthentik-pp-cli stages authenticator-duo-import-devices-automatic-create- Import duo devices into authentikauthentik-pp-cli stages authenticator-duo-list- AuthenticatorDuoStage Viewsetauthentik-pp-cli stages authenticator-duo-partial-update- AuthenticatorDuoStage Viewsetauthentik-pp-cli stages authenticator-duo-retrieve- AuthenticatorDuoStage Viewsetauthentik-pp-cli stages authenticator-duo-update- AuthenticatorDuoStage Viewsetauthentik-pp-cli stages authenticator-duo-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages authenticator-email-create- AuthenticatorEmailStage Viewsetauthentik-pp-cli stages authenticator-email-destroy- AuthenticatorEmailStage Viewsetauthentik-pp-cli stages authenticator-email-list- AuthenticatorEmailStage Viewsetauthentik-pp-cli stages authenticator-email-partial-update- AuthenticatorEmailStage Viewsetauthentik-pp-cli stages authenticator-email-retrieve- AuthenticatorEmailStage Viewsetauthentik-pp-cli stages authenticator-email-update- AuthenticatorEmailStage Viewsetauthentik-pp-cli stages authenticator-email-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages authenticator-endpoint-gdtc-create- AuthenticatorEndpointGDTCStage Viewsetauthentik-pp-cli stages authenticator-endpoint-gdtc-destroy- AuthenticatorEndpointGDTCStage Viewsetauthentik-pp-cli stages authenticator-endpoint-gdtc-list- AuthenticatorEndpointGDTCStage Viewsetauthentik-pp-cli stages authenticator-endpoint-gdtc-partial-update- AuthenticatorEndpointGDTCStage Viewsetauthentik-pp-cli stages authenticator-endpoint-gdtc-retrieve- AuthenticatorEndpointGDTCStage Viewsetauthentik-pp-cli stages authenticator-endpoint-gdtc-update- AuthenticatorEndpointGDTCStage Viewsetauthentik-pp-cli stages authenticator-endpoint-gdtc-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages authenticator-sms-create- AuthenticatorSMSStage Viewsetauthentik-pp-cli stages authenticator-sms-destroy- AuthenticatorSMSStage Viewsetauthentik-pp-cli stages authenticator-sms-list- AuthenticatorSMSStage Viewsetauthentik-pp-cli stages authenticator-sms-partial-update- AuthenticatorSMSStage Viewsetauthentik-pp-cli stages authenticator-sms-retrieve- AuthenticatorSMSStage Viewsetauthentik-pp-cli stages authenticator-sms-update- AuthenticatorSMSStage Viewsetauthentik-pp-cli stages authenticator-sms-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages authenticator-static-create- AuthenticatorStaticStage Viewsetauthentik-pp-cli stages authenticator-static-destroy- AuthenticatorStaticStage Viewsetauthentik-pp-cli stages authenticator-static-list- AuthenticatorStaticStage Viewsetauthentik-pp-cli stages authenticator-static-partial-update- AuthenticatorStaticStage Viewsetauthentik-pp-cli stages authenticator-static-retrieve- AuthenticatorStaticStage Viewsetauthentik-pp-cli stages authenticator-static-update- AuthenticatorStaticStage Viewsetauthentik-pp-cli stages authenticator-static-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages authenticator-totp-create- AuthenticatorTOTPStage Viewsetauthentik-pp-cli stages authenticator-totp-destroy- AuthenticatorTOTPStage Viewsetauthentik-pp-cli stages authenticator-totp-list- AuthenticatorTOTPStage Viewsetauthentik-pp-cli stages authenticator-totp-partial-update- AuthenticatorTOTPStage Viewsetauthentik-pp-cli stages authenticator-totp-retrieve- AuthenticatorTOTPStage Viewsetauthentik-pp-cli stages authenticator-totp-update- AuthenticatorTOTPStage Viewsetauthentik-pp-cli stages authenticator-totp-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages authenticator-validate-create- AuthenticatorValidateStage Viewsetauthentik-pp-cli stages authenticator-validate-destroy- AuthenticatorValidateStage Viewsetauthentik-pp-cli stages authenticator-validate-list- AuthenticatorValidateStage Viewsetauthentik-pp-cli stages authenticator-validate-partial-update- AuthenticatorValidateStage Viewsetauthentik-pp-cli stages authenticator-validate-retrieve- AuthenticatorValidateStage Viewsetauthentik-pp-cli stages authenticator-validate-update- AuthenticatorValidateStage Viewsetauthentik-pp-cli stages authenticator-validate-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages authenticator-webauthn-create- AuthenticatorWebAuthnStage Viewsetauthentik-pp-cli stages authenticator-webauthn-destroy- AuthenticatorWebAuthnStage Viewsetauthentik-pp-cli stages authenticator-webauthn-device-types-list- WebAuthnDeviceType Viewsetauthentik-pp-cli stages authenticator-webauthn-device-types-retrieve- WebAuthnDeviceType Viewsetauthentik-pp-cli stages authenticator-webauthn-list- AuthenticatorWebAuthnStage Viewsetauthentik-pp-cli stages authenticator-webauthn-partial-update- AuthenticatorWebAuthnStage Viewsetauthentik-pp-cli stages authenticator-webauthn-retrieve- AuthenticatorWebAuthnStage Viewsetauthentik-pp-cli stages authenticator-webauthn-update- AuthenticatorWebAuthnStage Viewsetauthentik-pp-cli stages authenticator-webauthn-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages captcha-create- CaptchaStage Viewsetauthentik-pp-cli stages captcha-destroy- CaptchaStage Viewsetauthentik-pp-cli stages captcha-list- CaptchaStage Viewsetauthentik-pp-cli stages captcha-partial-update- CaptchaStage Viewsetauthentik-pp-cli stages captcha-retrieve- CaptchaStage Viewsetauthentik-pp-cli stages captcha-update- CaptchaStage Viewsetauthentik-pp-cli stages captcha-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages consent-create- ConsentStage Viewsetauthentik-pp-cli stages consent-destroy- ConsentStage Viewsetauthentik-pp-cli stages consent-list- ConsentStage Viewsetauthentik-pp-cli stages consent-partial-update- ConsentStage Viewsetauthentik-pp-cli stages consent-retrieve- ConsentStage Viewsetauthentik-pp-cli stages consent-update- ConsentStage Viewsetauthentik-pp-cli stages consent-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages deny-create- DenyStage Viewsetauthentik-pp-cli stages deny-destroy- DenyStage Viewsetauthentik-pp-cli stages deny-list- DenyStage Viewsetauthentik-pp-cli stages deny-partial-update- DenyStage Viewsetauthentik-pp-cli stages deny-retrieve- DenyStage Viewsetauthentik-pp-cli stages deny-update- DenyStage Viewsetauthentik-pp-cli stages deny-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages dummy-create- DummyStage Viewsetauthentik-pp-cli stages dummy-destroy- DummyStage Viewsetauthentik-pp-cli stages dummy-list- DummyStage Viewsetauthentik-pp-cli stages dummy-partial-update- DummyStage Viewsetauthentik-pp-cli stages dummy-retrieve- DummyStage Viewsetauthentik-pp-cli stages dummy-update- DummyStage Viewsetauthentik-pp-cli stages dummy-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages email-create- EmailStage Viewsetauthentik-pp-cli stages email-destroy- EmailStage Viewsetauthentik-pp-cli stages email-list- EmailStage Viewsetauthentik-pp-cli stages email-partial-update- EmailStage Viewsetauthentik-pp-cli stages email-retrieve- EmailStage Viewsetauthentik-pp-cli stages email-templates-list- Get all available templates, including custom templatesauthentik-pp-cli stages email-update- EmailStage Viewsetauthentik-pp-cli stages email-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages identification-create- IdentificationStage Viewsetauthentik-pp-cli stages identification-destroy- IdentificationStage Viewsetauthentik-pp-cli stages identification-list- IdentificationStage Viewsetauthentik-pp-cli stages identification-partial-update- IdentificationStage Viewsetauthentik-pp-cli stages identification-retrieve- IdentificationStage Viewsetauthentik-pp-cli stages identification-update- IdentificationStage Viewsetauthentik-pp-cli stages identification-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages invitation-create- InvitationStage Viewsetauthentik-pp-cli stages invitation-destroy- InvitationStage Viewsetauthentik-pp-cli stages invitation-invitations-create- Invitation Viewsetauthentik-pp-cli stages invitation-invitations-destroy- Invitation Viewsetauthentik-pp-cli stages invitation-invitations-list- Invitation Viewsetauthentik-pp-cli stages invitation-invitations-partial-update- Invitation Viewsetauthentik-pp-cli stages invitation-invitations-retrieve- Invitation Viewsetauthentik-pp-cli stages invitation-invitations-update- Invitation Viewsetauthentik-pp-cli stages invitation-invitations-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages invitation-list- InvitationStage Viewsetauthentik-pp-cli stages invitation-partial-update- InvitationStage Viewsetauthentik-pp-cli stages invitation-retrieve- InvitationStage Viewsetauthentik-pp-cli stages invitation-update- InvitationStage Viewsetauthentik-pp-cli stages invitation-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages mtls-create- MutualTLSStage Viewsetauthentik-pp-cli stages mtls-destroy- MutualTLSStage Viewsetauthentik-pp-cli stages mtls-list- MutualTLSStage Viewsetauthentik-pp-cli stages mtls-partial-update- MutualTLSStage Viewsetauthentik-pp-cli stages mtls-retrieve- MutualTLSStage Viewsetauthentik-pp-cli stages mtls-update- MutualTLSStage Viewsetauthentik-pp-cli stages mtls-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages password-create- PasswordStage Viewsetauthentik-pp-cli stages password-destroy- PasswordStage Viewsetauthentik-pp-cli stages password-list- PasswordStage Viewsetauthentik-pp-cli stages password-partial-update- PasswordStage Viewsetauthentik-pp-cli stages password-retrieve- PasswordStage Viewsetauthentik-pp-cli stages password-update- PasswordStage Viewsetauthentik-pp-cli stages password-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages prompt-create- PromptStage Viewsetauthentik-pp-cli stages prompt-destroy- PromptStage Viewsetauthentik-pp-cli stages prompt-list- PromptStage Viewsetauthentik-pp-cli stages prompt-partial-update- PromptStage Viewsetauthentik-pp-cli stages prompt-prompts-create- Prompt Viewsetauthentik-pp-cli stages prompt-prompts-destroy- Prompt Viewsetauthentik-pp-cli stages prompt-prompts-list- Prompt Viewsetauthentik-pp-cli stages prompt-prompts-partial-update- Prompt Viewsetauthentik-pp-cli stages prompt-prompts-preview-create- Preview a prompt as a challenge, just like a flow would receiveauthentik-pp-cli stages prompt-prompts-retrieve- Prompt Viewsetauthentik-pp-cli stages prompt-prompts-update- Prompt Viewsetauthentik-pp-cli stages prompt-prompts-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages prompt-retrieve- PromptStage Viewsetauthentik-pp-cli stages prompt-update- PromptStage Viewsetauthentik-pp-cli stages prompt-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages redirect-create- RedirectStage Viewsetauthentik-pp-cli stages redirect-destroy- RedirectStage Viewsetauthentik-pp-cli stages redirect-list- RedirectStage Viewsetauthentik-pp-cli stages redirect-partial-update- RedirectStage Viewsetauthentik-pp-cli stages redirect-retrieve- RedirectStage Viewsetauthentik-pp-cli stages redirect-update- RedirectStage Viewsetauthentik-pp-cli stages redirect-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages source-create- SourceStage Viewsetauthentik-pp-cli stages source-destroy- SourceStage Viewsetauthentik-pp-cli stages source-list- SourceStage Viewsetauthentik-pp-cli stages source-partial-update- SourceStage Viewsetauthentik-pp-cli stages source-retrieve- SourceStage Viewsetauthentik-pp-cli stages source-update- SourceStage Viewsetauthentik-pp-cli stages source-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages user-delete-create- UserDeleteStage Viewsetauthentik-pp-cli stages user-delete-destroy- UserDeleteStage Viewsetauthentik-pp-cli stages user-delete-list- UserDeleteStage Viewsetauthentik-pp-cli stages user-delete-partial-update- UserDeleteStage Viewsetauthentik-pp-cli stages user-delete-retrieve- UserDeleteStage Viewsetauthentik-pp-cli stages user-delete-update- UserDeleteStage Viewsetauthentik-pp-cli stages user-delete-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages user-login-create- UserLoginStage Viewsetauthentik-pp-cli stages user-login-destroy- UserLoginStage Viewsetauthentik-pp-cli stages user-login-list- UserLoginStage Viewsetauthentik-pp-cli stages user-login-partial-update- UserLoginStage Viewsetauthentik-pp-cli stages user-login-retrieve- UserLoginStage Viewsetauthentik-pp-cli stages user-login-update- UserLoginStage Viewsetauthentik-pp-cli stages user-login-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages user-logout-create- UserLogoutStage Viewsetauthentik-pp-cli stages user-logout-destroy- UserLogoutStage Viewsetauthentik-pp-cli stages user-logout-list- UserLogoutStage Viewsetauthentik-pp-cli stages user-logout-partial-update- UserLogoutStage Viewsetauthentik-pp-cli stages user-logout-retrieve- UserLogoutStage Viewsetauthentik-pp-cli stages user-logout-update- UserLogoutStage Viewsetauthentik-pp-cli stages user-logout-used-by-list- Get a list of all objects that use this objectauthentik-pp-cli stages user-write-create- UserWriteStage Viewsetauthentik-pp-cli stages user-write-destroy- UserWriteStage Viewsetauthentik-pp-cli stages user-write-list- UserWriteStage Viewsetauthentik-pp-cli stages user-write-partial-update- UserWriteStage Viewsetauthentik-pp-cli stages user-write-retrieve- UserWriteStage Viewsetauthentik-pp-cli stages user-write-update- UserWriteStage Viewsetauthentik-pp-cli stages user-write-used-by-list- Get a list of all objects that use this object
tasks
Manage tasks
authentik-pp-cli tasks list- Listauthentik-pp-cli tasks retrieve- Retrieveauthentik-pp-cli tasks retry-create- Retry taskauthentik-pp-cli tasks schedules-list- Schedules listauthentik-pp-cli tasks schedules-partial-update- Schedules partial updateauthentik-pp-cli tasks schedules-retrieve- Schedules retrieveauthentik-pp-cli tasks schedules-send-create- Trigger this schedule nowauthentik-pp-cli tasks schedules-update- Schedules updateauthentik-pp-cli tasks status-retrieve- Global status summary for all tasksauthentik-pp-cli tasks workers-list- Get currently connected worker count.
Output Formats
# Human-readable table (default in terminal, JSON when piped)
authentik-pp-cli events list
# JSON for scripting and agents
authentik-pp-cli events list --json
# Filter to specific fields
authentik-pp-cli events list --json --select id,name,status
# Dry run — show the request without sending
authentik-pp-cli events list --dry-run
# Agent mode — JSON + compact + no prompts in one flag
authentik-pp-cli events list --agent
Agent Usage
This CLI is designed for AI agent consumption:
- Non-interactive - never prompts, every input is a flag
- Pipeable -
--jsonoutput to stdout, errors to stderr - Filterable -
--select id,namereturns only fields you need - Previewable -
--dry-runshows the request without sending - Explicit retries - add
--idempotentto create retries and--ignore-missingto delete retries when a no-op success is acceptable - Confirmable -
--yesfor explicit confirmation of destructive actions - Piped input - write commands can accept structured input when their help lists
--stdin - Offline-friendly - sync/search commands can use the local SQLite store when available
- Agent-safe by default - no colors or formatting unless
--human-friendlyis set
Exit codes: 0 success, 2 usage error, 3 not found, 4 auth error, 5 API error, 7 rate limited, 10 config error.
Health Check
authentik-pp-cli doctor
Verifies configuration, credentials, and connectivity to the API.
Configuration
Config file: ~/.config/authentik-pp-cli/config.toml
Static request headers can be configured under headers; per-command header overrides take precedence.
Environment variables:
| Name | Kind | Required | Description |
|---|---|---|---|
AUTHENTIK_TOKEN | per_call | Yes | Set to your API credential. |
Troubleshooting
Authentication errors (exit code 4)
- Run
authentik-pp-cli doctorto check credentials - Verify the environment variable is set:
echo $AUTHENTIK_TOKENNot found errors (exit code 3) - Check the resource ID is correct
- Run the
listcommand to see available items
API-specific
- 401 Unauthorized — Confirm AUTHENTIK_TOKEN is set and the token has admin scope:
echo $AUTHENTIK_TOKEN | head -c 8 - Connection refused — Confirm AUTHENTIK_BASE_URL is reachable:
curl -I $AUTHENTIK_BASE_URL/-/health/live/
Sources & Inspiration
This CLI was built by studying these projects and resources:
- goauthentik/terraform-provider-authentik — Go (200 stars)
- goauthentik/client-python — Python (30 stars)
Generated by CLI Printing Press
For agents: pass /documentation/authentik/agents.md to install this CLI from a prompt.