API Bearer Auth
The API Bearer Auth plugin enables authentication for the REST API by using JWT access an refresh tokens. After the user logs in, the access and refresh tokens are returned and can be used for the next requests. Issued tokens can be revoked from within the users admin screen. See below for the endpoints. Note that after activating this plugin, all REST API endpoints will need to be authenticated, unless the endpoint is whitelisted in the api_bearer_auth_unauthenticated_urls filter (see FAQ for how to use this filter). JWT Access tokens can be formatted as JWT tokens. For this to work, you first have to create a secret and add it to the wp-config.php file. If you don’t do this, access tokens will work also, but are just random strings. To create a random secret key, you can do for example: base64_encode(openssl_random_pseudo_bytes(64)); And then add the result to wp-config: define('API_BEARER_JWT_SECRET', 'mysecretkey'); If you have problems, you can verify your JWT tokens at: https://jwt.io/ Revoke tokens This plugin adds a column to the users table in de admin where you can see when a token expires. You can also revoke tokens by selection the “Revoke API tokens” from the bulk actions select box. API endpoints Note that all endpoints expect JSON in the POST body. Login Endpoint: POST /api-bearer-auth/v1/login Request body: Note: client_name is optional. But if you use it, make sure to use it as well for the refresh call! {"username": "my_username", "password": "my_password", "client_name": "my_app"} Response: { "wp_user": { "data": { "ID": 1, "user_login": "your_user_login", // other default WordPress user fields } }, "access_token": "your_access_token", "expires_in": 86400, // number of seconds "refresh_token": "your_refresh_token" } Make sure to save the access and refresh token! Refresh access token Endpoint: POST /api-bearer-auth/v1/tokens/refresh Request body: Note: client_name is optional. But if you did use it for the login call, make sure to use it here as well! {"token": "your_refresh_token", "client_name": "my_app"} Response success: { "access_token": "your_new_access_token", "expires_in": 86400 } Response when sending a wrong refresh token is a 401: { "code": "api_api_bearer_auth_error_invalid_token", "message": "Invalid token.", "data": { "status": 401 } } Do a request After you have the access token, you can make requests to authenticated endpoints with an Authorization header like this: Authorization: Bearer Note that Apache sometimes strips out the Authorization header. If this is the case, make sure to add this to the .htaccess file: RewriteCond %{HTTP:Authorization} ^(.*) # Don't know why, but some need the line below instead of the RewriteRule line # SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0 RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1] If you are not logged in or you send an invalid access token, you get a 401 response: { "code": "api_bearer_auth_not_logged_in", "message": "You are not logged in.", "data": { "status": 401 } } Important update Update immediately if you’re using a version below 20200807. Before this version all access tokens were updated when calling the refresh callback. If you are affected by this the fastest solution is to execute this query: update wp_user_tokens set access_token_valid = NOW(); This will invalidate all access tokens. This means that all users need to refresh their access token and will get a new access token and a unique one this time. A big thank to @harchvertelol for reporting this and suggesting the fix as well!
Top keywords
- token19×3.23%
- access17×2.89%
- tokens14×2.38%
- refresh12×2.04%
- access token10×1.70%
- api9×1.53%
- authorization7×1.19%
- bearer6×1.02%
- jwt6×1.02%
- user6×1.02%
- endpoints5×0.85%
- login5×0.85%
WP-Members Membership Plugin
The original WordPress membership plugin with content restriction, user login, custom registration fields, user profiles, and more. Membership Sites. Simplified. You need a membership site, but you want to focus on your business, not mastering a plugin. WP-Members is simple to use, easy to set up, yet flexible in every way imaginable. Simple to install and configure – yet customizable and scalable! Features: Restrict or hide posts, pages, and custom post types Limit menu items to logged in users User login, registration, and profile integrated into your theme Create custom registration and profile fields Integrate custom fields into WooCommerce checkout and registration (only supported by shortcode pages, not block editor version) Create custom memberships and content restriction Notify admin of new user registrations Hold new registrations for admin approval Create post excerpt teaser content automatically Shortcodes for login, registration, content restriction, and more Create powerful customizations with more than 120 action and filter hooks A library of API functions for extensibility WP-Members allows you to restrict content as restricted or hidden, limiting access to registered users. A full Users Guide is available here. The guide outlines the installation process, and also documents how to use all of the settings. Support There is freely available documentation on the plugin’s support site. Your question may be answered there. If you need assistance configuring the plugin or have questions on how to implement or customize features, premium support is available. You can get priority support along with all of the plugin’s premium extensions in one cost saving Pro Bundle! Premium Support Premium support subscribers have access to priority email support, examples, tutorials, and code snippets that will help you extend and customize the base plugin using the plugin’s framework. Visit the site for more info. Free Extensions Stop Spam Registrations – Uses stopforumspam.com’s API to block spam registrations. Send Test Emails – A utility to send test versions of the plugin’s emails. Premium Extensions The plugin has several premium extensions for additional functionality. You can purchase any of them individually, or get them all for a significant discount in the Pro Bundle. Advanced Options – adds additional settings to WP-Members for redirecting core WP created URLs, redirecting restricted content, hiding the WP toolbar, and more! Also includes integrations with popular plugins like WooCommerce, BuddyPress, bbPress, ADF, Easy Digital Downloads, and The Events Calendar. Download Protect – Allows you to restrict access to specific files, requiring the user to be logged in to access. Invite Codes – set up invitation codes to restrict registration to only those with a valide invite code. MailChimp Integration – add MailChimp list subscription to your registation form. Memberships for WooCommerce – Sell memberships through WooCommerce. PayPal Subscriptions – Sell restricted content access through PayPal. Security – adds a number of security features to the plugin such as preventing concurrent logins, registration form honey pot (spam blocker), require passwords be changed on first use, require passwords to be changed after defined period of time, require strong passwords, block registration by IP and email, restrict specified usernames from being registered. Text Editor – Adds an editor to the WP-Members admin panel to easily customize all user facing strings in the plugin. User List – Display lists of users on your site. Great for creating user directories with detailed and customizable profiles. User Tracking – Track what pages logged in users are visting and when. WordPass Pro – Change your random password generator from gibberish to word-based passwords (can be used with or without WP-Members). Get support along with all of the plugin’s premium extensions in one cost saving Pro Bundle!