Base Endpoints

User

使用此端点来检索/更新用户.

预设网址: /users/me/ 向后兼容网址: /me/

Method Request Response
GET

HTTP_200_OK

  • {{ User.USERNAME_FIELD }}
  • {{ User._meta.pk.name }}
  • {{ User.REQUIRED_FIELDS }}
PUT {{ User.REQUIRED_FIELDS }}

HTTP_200_OK

  • {{ User.USERNAME_FIELD }}
  • {{ User._meta.pk.name }}
  • {{ User.REQUIRED_FIELDS }}

User Create

使用此端点注册新用户. 您的用户模型管理员应实现create_user方法,并具有USERNAME_FIELDREQUIRED_FIELDS字段.

预设网址: /users/ 向后兼容网址: /users/create/

Method Request Response
POST
  • {{ User.USERNAME_FIELD }}
  • {{ User.REQUIRED_FIELDS }}
  • password

HTTP_201_CREATED

  • {{ User.USERNAME_FIELD }}
  • {{ User._meta.pk.name }}
  • {{ User.REQUIRED_FIELDS }}

User Delete

使用此端点删除经过身份验证的用户. 默认情况下,它将仅验证current_password提供的密码,如果使用了基于令牌的身份验证则删除auth令牌,并为给定的User实例调用delete. 自定义删除行为的一种方法是覆盖User.delete .

预设网址: /users/me/

Method Request Response
DELETE
  • current_password

HTTP_204_NO_CONTENT

HTTP_400_BAD_REQUEST

  • current_password

向后兼容网址: /users/delete/

Method Request Response
POST
  • current_password

HTTP_204_NO_CONTENT

HTTP_400_BAD_REQUEST

  • current_password

User Activate

使用此端点来激活用户帐户. 该终结点不是将直接向您的用户公开的URL-您应在前端应用程序(由ACTIVATION_URL配置)中提供站点,该站点将发送POST请求以激活终结点.

预设网址: /users/confirm/ 向后兼容网址: /users/activate/

Method Request Response
POST
  • uid
  • token
HTTP_204_NO_CONTENT

Set Username

使用此端点来更改用户用户名( USERNAME_FIELD ).

预设网址: /users/change_username/ 向后兼容网址: /{{ User.USERNAME_FIELD }}/

Note

仅当SET_USERNAME_RETYPETrue时才需要re_new_{{ User.USERNAME_FIELD }}

Method Request Response
POST
  • new_{{ User.USERNAME_FIELD }}
  • re_new_{{ User.USERNAME_FIELD }}
  • current_password
HTTP_204_NO_CONTENT

Set Password

使用此端点更改用户密码.

预设网址: /password/

Note

仅当SET_PASSWORD_RETYPETrue时才需要re_new_password

Method Request Response
POST
  • new_password
  • re_new_password
  • current_password
HTTP_204_NO_CONTENT

Reset Password

使用此端点可以通过密码重置链接向用户发送电子邮件. 您必须设置PASSWORD_RESET_CONFIRM_URL .

预设网址: /password/reset/

Note

HTTP_204_NO_CONTENT if PASSWORD_RESET_SHOW_EMAIL_NOT_FOUND is False

否则,如果数据库HTTP_400_BAD_REQUEST中不存在email

Method Request Response
POST email
  • HTTP_204_NO_CONTENT
  • HTTP_400_BAD_REQUEST

Reset Password Confirmation

使用此端点完成重置密码过程. 该终结点不是将直接向您的用户公开的URL-您应该在前端应用程序(由PASSWORD_RESET_CONFIRM_URL配置)中提供站点,该站点将发送POST请求以重置密码确认终结点.

预设网址: /password/reset/confirm/

Note

仅当PASSWORD_RESET_CONFIRM_RETYPETrue时才需要re_new_password

Method Request Response
POST
  • uid
  • token
  • new_password
  • re_new_password
HTTP_204_NO_CONTENT