For AI agents: the complete documentation index is available at https://www.jumpserver.com/docs/llms.txt, the full documentation bundle is available at https://www.jumpserver.com/docs/llms-full.txt, and this page is available as Markdown at https://www.jumpserver.com/docs/developer-guide/integrations.md.
🎉 JumpServer v5.1.1 is available. See what's new →
  • v5

    • Integrations

    JumpServer integrates with external systems through a small set of supported surfaces: the REST API for automation, notification channels for outbound messages, Syslog for log collection, and PAM integration applications for controlled account access.

    Integration surfaces

    SurfaceDirectionUse it for
    REST APIPull and pushAutomate users, assets, accounts, permissions, sessions, and tickets
    NotificationsOutboundEmail, SMS, and subscription-based platform alerts
    SyslogOutboundSend application logs to an external Syslog server
    PAM integration applicationsOutbound APIProvide controlled account credential retrieval to external applications
    AuthenticationInboundLDAP, CAS, OIDC, SAML2, OAuth2, and social login providers

    REST API

    The REST API is the primary integration surface. Use it when an external system must read or change records on demand:

    • Base path: /api/v1/
    • Documentation: /api/docs/ and /api/swagger.json
    • Authentication: session, access key, private token, or OAuth2
    • Pagination: limit and offset

    See REST API for authentication and endpoint groups.

    Notification channels

    JumpServer sends account, authorization, security, and monitoring messages through email and SMS, and lets users subscribe to in-site or email alerts.

    1. Open System Settings > Notifications.
    2. Configure Email for transactional messages.
    3. Configure Message (SMS) when SMS verification or password recovery is required.
    4. Configure Subscription to select message types and recipients.

    Notification settings

    See System Settings > Notifications for the full configuration reference.

    Syslog

    Application logs can be sent to an external Syslog server through the deployment configuration:

    • SYSLOG_ADDR — Syslog server address
    • SYSLOG_FACILITY — Syslog facility
    • SYSLOG_SOCKTYPE — socket type

    These values belong to the deployment configuration and require a service restart. See Configuration and Command-Line Tools.

    PAM integration applications

    PAM integration applications expose account credentials to external systems through a controlled API, without giving those systems direct access to the credential store.

    1. Open PAM > Integration > Applications.
    2. Create an application and select the accounts it may access.
    3. Distribute the application credentials to the consuming system.

    PAM integration applications

    See PAM > Applications for the application workflow.

    Authentication providers

    For inbound identity integration, configure LDAP, CAS, OIDC, SAML2, OAuth2, or a supported social provider under System Settings > Authentication. See Authentication.

    Notes

    • Use HTTPS for every external integration and store credentials outside source control.
    • Prefer a dedicated service account with the minimum required permissions for API and PAM integrations.