In order to set up GroupMe authentication, you need to register an application on GroupMe. This can be done from the GroupMe website.
Registering an application¶
Go to https://dev.groupme.com/applications/new and log in with your GroupMe account.
Give your application a name.
You should choose a name that reflects the community you have set up FreeField for. A good idea is to use the name of your community, or a location-specific name such as “New York FreeField.” You may optionally upload an icon for your application, which will be displayed when users attempt to authenticate.
In the “Callback URL” box, paste the redirect URL for FreeField’s implementation of OAuth2 with GroupMe. This URL is
auth/oa2/groupme.php, relative to your installation path. E.g. if you have installed FreeField to
https://example.com/freefield/, the redirect URL would be
- Fill in the rest of the form with your own contact details. Click “Save” when you are done.
- Take note of the client ID assigned to your application. The client ID can be found at the end of the redirect URL now displayed on the page.
Enabling GroupMe authentication in FreeField¶
After you have registered an application on GroupMe, you can configure FreeField to use GroupMe for authentication.
- In the FreeField administration pages, navigate to the “Authentication” menu.
- In the GroupMe section, check the box next to “Enable GroupMe authentication” and paste the client ID you got from GroupMe in the relevant field.
- Save the setting using “Save settings” at the bottom of the page.
When users authenticate with FreeField through GroupMe, they will see an authentication prompt similar to this:
When they log in, they will be redirected back to FreeField and be signed in automatically.