{"id":13481678,"url":"https://github.com/apragacz/django-rest-registration","last_synced_at":"2025-10-08T22:06:00.939Z","repository":{"id":38355816,"uuid":"48646785","full_name":"apragacz/django-rest-registration","owner":"apragacz","description":"User-related REST API based on the awesome Django REST Framework","archived":false,"fork":false,"pushed_at":"2025-06-24T13:04:34.000Z","size":3215,"stargazers_count":552,"open_issues_count":15,"forks_count":87,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-06-24T14:22:54.442Z","etag":null,"topics":["auth","authentication","change-password","django","django-application","django-rest-framework","django-rest-registration","drf","login","python-3","register","registration","reset-password","rest-api","sign-in","sign-up","signin","signup"],"latest_commit_sha":null,"homepage":"https://django-rest-registration.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apragacz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-12-27T13:51:11.000Z","updated_at":"2025-06-24T13:03:13.000Z","dependencies_parsed_at":"2023-11-02T13:36:36.275Z","dependency_job_id":"e730ac11-ff5a-45e9-92dd-263aadf4aea4","html_url":"https://github.com/apragacz/django-rest-registration","commit_stats":{"total_commits":684,"total_committers":28,"mean_commits":"24.428571428571427","dds":"0.26900584795321636","last_synced_commit":"7b92909b8347b2add65a1ef688c1fca82b1687d0"},"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"purl":"pkg:github/apragacz/django-rest-registration","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apragacz%2Fdjango-rest-registration","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apragacz%2Fdjango-rest-registration/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apragacz%2Fdjango-rest-registration/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apragacz%2Fdjango-rest-registration/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apragacz","download_url":"https://codeload.github.com/apragacz/django-rest-registration/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apragacz%2Fdjango-rest-registration/sbom","scorecard":{"id":204262,"data":{"date":"2025-08-11","repo":{"name":"github.com/apragacz/django-rest-registration","commit":"11ff72a28ff88f8a8bc3009a0eb9cc15f04c0dbd"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.2,"checks":[{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Maintained","score":5,"reason":"5 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":1,"reason":"Found 1/7 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":9,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28","Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/apragacz/django-rest-registration/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/apragacz/django-rest-registration/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/apragacz/django-rest-registration/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/apragacz/django-rest-registration/codeql-analysis.yml/master?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.9.0 not signed: https://api.github.com/repos/apragacz/django-rest-registration/releases/172908646","Warn: release artifact v0.8.3 not signed: https://api.github.com/repos/apragacz/django-rest-registration/releases/132584814","Warn: release artifact v0.8.2 not signed: https://api.github.com/repos/apragacz/django-rest-registration/releases/104320406","Warn: release artifact v0.8.1 not signed: https://api.github.com/repos/apragacz/django-rest-registration/releases/101847327","Warn: release artifact v0.8.0 not signed: https://api.github.com/repos/apragacz/django-rest-registration/releases/97610302","Warn: release artifact v0.9.0 does not have provenance: https://api.github.com/repos/apragacz/django-rest-registration/releases/172908646","Warn: release artifact v0.8.3 does not have provenance: https://api.github.com/repos/apragacz/django-rest-registration/releases/132584814","Warn: release artifact v0.8.2 does not have provenance: https://api.github.com/repos/apragacz/django-rest-registration/releases/104320406","Warn: release artifact v0.8.1 does not have provenance: https://api.github.com/repos/apragacz/django-rest-registration/releases/101847327","Warn: release artifact v0.8.0 does not have provenance: https://api.github.com/repos/apragacz/django-rest-registration/releases/97610302"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (24) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"17 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-29gw-9793-fvw7","Warn: Project is vulnerable to: PYSEC-2015-24 / GHSA-4vwq-x64q-j4cj","Warn: Project is vulnerable to: PYSEC-2017-46 / GHSA-66gw-5xpf-gfp5","Warn: Project is vulnerable to: PYSEC-2015-25 / GHSA-92mr-v722-f48m","Warn: Project is vulnerable to: PYSEC-2022-12 / GHSA-pq7m-3gw7-gq5x","Warn: Project is vulnerable to: PYSEC-2017-47","Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v","Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h","Warn: Project is vulnerable to: GHSA-7xr5-9hcq-chf9","Warn: Project is vulnerable to: PYSEC-2025-13 / GHSA-p3fp-8748-vqfq","Warn: Project is vulnerable to: PYSEC-2025-1 / GHSA-qcgg-j2x8-h9g8","Warn: Project is vulnerable to: PYSEC-2025-14 / GHSA-wqfg-m96j-85vm"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T23:21:43.206Z","repository_id":38355816,"created_at":"2025-08-16T23:21:43.206Z","updated_at":"2025-08-16T23:21:43.206Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000730,"owners_count":26082847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auth","authentication","change-password","django","django-application","django-rest-framework","django-rest-registration","drf","login","python-3","register","registration","reset-password","rest-api","sign-in","sign-up","signin","signup"],"created_at":"2024-07-31T17:00:54.116Z","updated_at":"2025-10-08T22:06:00.905Z","avatar_url":"https://github.com/apragacz.png","language":"Python","funding_links":[],"categories":["Packages","D"],"sub_categories":["Authentication"],"readme":"# Django REST Registration\n\n[![CircleCI Build Status](https://circleci.com/gh/apragacz/django-rest-registration.svg?style=shield)](https://circleci.com/gh/apragacz/django-rest-registration)\n[![Codecov Coverage](https://codecov.io/gh/apragacz/django-rest-registration/branch/master/graphs/badge.svg?branch=master)](https://codecov.io/github/apragacz/django-rest-registration?branch=master)\n[![PyPi Version](https://badge.fury.io/py/django-rest-registration.svg)](https://pypi.python.org/pypi/django-rest-registration/)\n[![Documentation Status](https://readthedocs.org/projects/django-rest-registration/badge/?version=latest)](https://django-rest-registration.readthedocs.io/en/latest/?badge=latest)\n\nUser registration REST API, based on Django REST Framework.\n\n## Documentation\n\nFull documentation for the project is available at [https://django-rest-registration.readthedocs.io/](https://django-rest-registration.readthedocs.io/).\n\n## Requirements\n\n* Django (2.0+, 3.0+, 4.0+, 5.0+) and Django-REST-Framework (3.3+)\n* Python 3.7 or higher (no Python 2 support!)\n\n## Features\n\n* Supported views:\n    * registration (sign-up) with verification\n    * login/logout (sign-in), session- or token-based\n    * user profile (retrieving / updating)\n    * reset password\n    * change password\n    * register (change) e-mail\n* Views are compatible with [django-rest-swagger](https://github.com/marcgibbons/django-rest-swagger)\n* Views can be authenticated via session or auth token\n* Modeless (uses the user defined by `settings.AUTH_USER_MODEL` and also uses [cryptographic signing](https://docs.djangoproject.com/en/dev/topics/signing/) instead of profile models)\n* Uses [password validation](https://docs.djangoproject.com/en/dev/topics/auth/passwords/#password-validation)\n* Heavily tested (Above 98% code coverage)\n\n\n## Current limitations\n\n*   Supports only one email per user (as model field)\n*   No JWT support (but you can easily\n    [implement one](https://django-rest-registration.readthedocs.io/en/latest/cookbook/jwt.html)\n    or use Django REST Registration along libraries like\n    [django-rest-framework-simplejwt](https://github.com/davesque/django-rest-framework-simplejwt))\n\n\n## Installation \u0026 Configuration\n\nYou can [install](https://django-rest-registration.readthedocs.io/en/latest/install.html)\nDjango REST Registration latest version via pip:\n\n    pip install django-rest-registration\n\nThen, you should add it to the `INSTALLED_APPS` so the app templates\nfor notification emails can be accessed:\n\n```python\nINSTALLED_APPS=(\n    ...\n\n    'rest_registration',\n)\n```\nAfter that, you can use the urls in your urlconfig, for instance:\n\n```python\napi_urlpatterns = [\n    ...\n\n    path('accounts/', include('rest_registration.api.urls')),\n]\n\n\nurlpatterns = [\n    ...\n\n    path('api/v1/', include(api_urlpatterns)),\n]\n```\n\nYou can configure Django REST Registration using the `REST_REGISTRATION`\nsetting in your Django settings (similarly to Django REST Framework).\n\nBelow is sample, minimal config you can provide in your django settings which will satisfy the system checks:\n\n```python\nREST_REGISTRATION = {\n    'REGISTER_VERIFICATION_ENABLED': False,\n    'RESET_PASSWORD_VERIFICATION_ENABLED': False,\n    'REGISTER_EMAIL_VERIFICATION_ENABLED': False,\n}\n```\n\nHowever, the preferred base configuration would be:\n\n```python\nREST_REGISTRATION = {\n    'REGISTER_VERIFICATION_URL': 'https://frontend-host/verify-user/',\n    'RESET_PASSWORD_VERIFICATION_URL': 'https://frontend-host/reset-password/',\n    'REGISTER_EMAIL_VERIFICATION_URL': 'https://frontend-host/verify-email/',\n\n    'VERIFICATION_FROM_EMAIL': 'no-reply@example.com',\n}\n```\n\nThe frontend urls are not provided by the library but should be provided\nby the user of the library, because Django REST Registration is frontend-agnostic.\nThe frontend urls will receive parameters as GET query and should pass\nthem to corresponding REST API views via HTTP POST request.\n\nIn case when any verification is enabled (which is the default!),\nyour Django application needs to be\n[properly configured so it can send e-mails](https://docs.djangoproject.com/en/dev/topics/email/).\n\nYou can read more about basic configuration\n[here](https://django-rest-registration.readthedocs.io/en/latest/quickstart.html).\n\nYou can read more about detailed configuration\n[here](https://django-rest-registration.readthedocs.io/en/latest/detailed_configuration/).\n\n## Configuration options\n\nYou can find all `REST_REGISTRATION` configuration options\n[here](https://django-rest-registration.readthedocs.io/en/latest/detailed_configuration/all_settings.html).\n\n## Contributing\n\nIf you want to contribute, please refer to separate document [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapragacz%2Fdjango-rest-registration","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapragacz%2Fdjango-rest-registration","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapragacz%2Fdjango-rest-registration/lists"}