Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,50 @@ Documentation generated with [mkdocs.org](http://mkdocs.org).
provide common user-related functionality such as custom avatars and email verification
during the registration process. The API views provide endpoints to support this
functionality.

## API endpoints

Including `user_management.api.urls` will give the following API endpoints:
- `auth`
- `password_reset`
- `profile`
- `register`

If you need more control, urls are split across several files and can be included
[individually](docs/views).

Auth:

- url: `/auth`

Password reset:

- url: `/auth/password_reset/confirm/<uid>/<token>`
- url: `/auth/password_reset`

Profile:

- url: `/profile`
- url: `/profile/password`

Register:

- url: `/register`
- url: `/resend-confirmation-email`

Users:

- url: `/users`
- url: `/users/<pk>`

Verify email:

- url: `/verify_email/<uid>/<token>`

Profile avatar:

- url: `/profile/avatar`

User avatar:

- url: `/users/<pk>/avatar`