Papertrail
Connect Papertrail to Ploy to see every user in your Papertrail account, their permissions, and which log groups a restricted user can see. Ploy can also invite people to the account, switch them between read-only and full log access, give or remove their other permissions, add them to or remove them from log groups, and remove them from the account.
This integration is in beta
The Papertrail integration is in beta. It was built from Papertrail's API documentation and has not yet been checked against a live Papertrail account, so some details may need adjusting once customers connect it. Beta does not limit what the integration can do.
The first step of setup is a consent checkbox. Ticking it lets Ploy capture redacted error data when a request to Papertrail fails: the error response Papertrail sends back, with personal details, tokens and other secrets removed. Ploy uses it only to fix problems with this integration. You must tick the box to continue.
What Ploy reads
Every user in your Papertrail account, with their email address
Each user's permissions: read-only or full log access, managing members, managing billing, purging logs, and access to all log groups
For users restricted to some log groups, which log groups they can see
Every log group in your account
Ploy does not read your logs, saved searches, systems, log destinations, archives or usage.
Before you start
The token you give Ploy acts as the Papertrail user it belongs to, so use a user who can manage members and permissions. Ploy can then see and change exactly what that user can.
Papertrail does not let anyone change their own permissions, so Ploy cannot change the permissions of the user whose token it holds.
Copy your API token in Papertrail
Sign in to Papertrail as a user who can manage members and permissions.
Open your profile page (your name or the account menu, then Profile).
Copy the API token shown there. Treat it like a password.
Connect Papertrail in Ploy
In Ploy, open Integrations and choose Papertrail.
Tick the beta consent checkbox.
Paste the API token into Papertrail API token.
Select Test and save. Ploy checks the token by reading your Papertrail users.
The first scan starts straight away. Users are scanned every hour and log groups every six hours.
What Ploy can change
Invite a user: Ploy invites the email address with read-only access to all log groups, or full access if you choose it. Papertrail sends the invitation. Someone who is already a user is left as they are. An invited person appears in Ploy once Papertrail lists them.
Change access level: switches a user between Read-only and Full access. Papertrail always gives full access to anyone who manages members or billing, so remove those permissions first if you want such a user to be read-only.
Give or remove a permission: Manage members, Manage billing, Purge logs and All log groups can be given or removed from the user's Papertrail access in Ploy. Purging logs needs full access to all log groups. To take All log groups away, restrict the user to their log groups in Papertrail.
Log group access: adds a restricted user to a log group or removes them from one. A user who can see every log group already has access; to remove one group from them, restrict them in Papertrail first. Ploy does not remove a user's only log group.
Remove a user: removes the user from the Papertrail account. Removing someone who is already gone counts as done.
Troubleshooting
Papertrail refused that API token: copy the token again in full from the profile page and test again.
Papertrail refused to list users: the token belongs to a user who cannot manage members. Use a token from a user who can.