This module adds new JSON:API endpoints for user accounts, enabling features like user registration, password resets, and password updates. These endpoints are useful for decoupled or headless Drupal applications that require user interaction.
Provides JSON:API enhancements for user accounts using the JSON:API Resources. The additional endpoints will assist with building a decoupled/headless Drupal application that allows authenticated users to register, login, reset passwords, etc.
This module adds the following JSON:API endpoints:
/jsonapi/user/register: Register a new user/jsonapi/user/password/reset: Reset user password/user/{user}/password/update: Update user password
Note that the user password may also be updated using the /jsonapi/user/user/{user} endpoint provided by Drupal core.
Example requests
/jsonapi/user/register
curl --location 'https://www.example.com/jsonapi/user/register' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--data-raw '{
"data": {
"type": "user--user",
"attributes": {
"name": "test 123",
"mail": "[email protected]",
"pass": "test"
}
}
}'
/jsonapi/user/password/reset
curl --location 'https://example.com/jsonapi/user/password/reset' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/json' \
--data-raw '{
"data": {
"type": "user--password-reset",
"attributes": {
"mail": "[email protected]"
}
}
}'
Ask your assistant about JSON:API User Resources
Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works
Depends on
Dependencies of the latest stable release
No dependencies recorded for this project.
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
Activity
Releases
| Version | Type | Core | PHP | Release date | |
|---|---|---|---|---|---|
| 8.x-1.0-beta2 | Pre-release | 10–11 | Oct 14, 2024 | ||
| 8.x-1.0-beta1 | Pre-release | 9–10 | Mar 30, 2023 |