Search Results for

    Show / Hide Table of Contents

    Base Endpoints

    BaseEndpointsController<TUserKey, TUser>

    User Create

    Use this endpoint to register new user.

    Default URL: /users

    Authorizations : (None)

    Method Request Response
    POST
    • email
    • username
    • password
    • confirmPassword
    • HTTP_200_OK
    • HTTP_400_BAD_REQUEST

    User Verify Email

    Use this endpoint to send email verification link via email. You should provide site in your frontend application (configured by AuthEndpointsOptions.EmailConfirmationUrl) which will send POST request to verify email confirmation endpoint.

    Default URL: /users/verify_email

    Authorizations : (Jwt)

    Method Request Response
    GET - HTTP_204_NO_CONTENT, HTTP_401_UNAUTHORIZED

    User Verify Email Confirmation

    Use this endpoint to finish email verification process.

    Default URL: /users/verify_email_confirm

    Authorizations : (Jwt or None)

    Method Request Response
    POST
    • identity
    • token
    HTTP_204_NO_CONTENT, HTTP_400_BAD_REQUEST, HTTP_401_UNAUTHORIZED, HTTP_409_CONFLICT

    User Retrieve

    Use this endpoint to retrieve the authenticated user data.

    Default URL: /users/me

    Authorizations : (Jwt)

    Method Request Response
    GET - HTTP_200_OK
    • User data

    Set Password

    Use this endpoint to change user password.

    Default URL: /users/set_password

    Authorizations : (Jwt)

    Method Request Response
    POST
    • currentPassword
    • newPassword
    • confirmNewPassword
    • HTTP_204_NO_CONTENT
    • HTTP_400_BAD_REQUEST

    Reset Password

    Use this endpoint to send email to user with password reset link. You should provide site in your frontend application (configured by AuthEndpointsOptions.PasswordResetUrl) which will send POST request to reset password confirmation endpoint.

    Default URL: /users/reset_password

    Authorizations : (None)

    Method Request Response
    POST
    • Email
    • HTTP_204_NO_CONTENT
    • HTTP_400_BAD_REQUEST
    • HTTP_401_UNAUTHORIZED
    • HTTP_404_NOT_FOUND

    Reset Password Confirmation

    Use this endpoint to finish reset password process.

    Default URL: /users/reset_password_confirm

    Authorizations : (None)

    Method Request Response
    POST
    • identity
    • token
    • newPassword
    • confirmNewPassword
    • HTTP_204_NO_CONTENT
    • HTTP_400_BAD_REQUEST
    • HTTP_404_NOT_FOUND
    • HTTP_409_CONFLICT
    • Improve this Doc
    In This Article
    Back to top Developed by MadeY and contributors / Licensed under MIT / Website generated by DocFX