FreeScout

Requirements

• FreeScout OAuth Social Login Module (one-time fee)
• HTTPS connection to your FreeScout server

Create the client in Pocket ID

1. In Pocket ID, open Administration → OIDC Clients and click Add OIDC Client.
2. Enter a name such as FreeScout and add the callback URL https://freescout.example.com/oauth-login/callback/*.
3. Click Create and copy the Client ID and the Client secret. Under Show more details, also copy the Authorization URL, the Token URL and the Userinfo URL. The client secret is only shown once.
4. On the client’s Access tab, select the groups that may sign in under Allowed User Groups, or choose All Users.

After creating the OAuth provider in FreeScout, replace the callback URL with the exact Redirect URI generated by FreeScout.

Configure FreeScout

1. In FreeScout, open Manage → Settings → OAuth.
2. Enable the Active checkmark.
3. Fill in the required fields:
   • Provider: Custom Oauth Provider
   • Name: Pocket ID or similar.
   • Redirect URI: copy this value into the Callback URLs of the client in Pocket ID, replacing the one you added earlier.
   • Logout URI: leave the generated value provided by FreeScout.
   • Client ID: the Client ID from Pocket ID.
   • Client Secret: the Client secret from Pocket ID.
   • Authorization URL: the Authorization URL from Pocket ID.
   • Token URL: the Token URL from Pocket ID.
   • User Info URL: the Userinfo URL from Pocket ID.
   • User Info Method: POST
   • Proxy URL, Field Mappings, Scopes: leave blank unless your environment needs them.
4. Save the settings and sign in with Pocket ID to test it.

Optional settings

• Enable Auto-Create Users to create users in FreeScout automatically when they sign in with Pocket ID for the first time.
• Enable Force OAuth Login to force sign-in with Pocket ID. Don’t enable this until you have fully tested the setup. To disable it again, see the module documentation.
• Enable Debug Mode to examine the OAuth transaction in the FreeScout logs. You can disable it again after testing.