Account
User Account REST APIs
| API | Description |
|---|---|
| POST api/Account/RegisterUser |
Register a new user account. |
| GET api/Account/GetLoginInfo |
Gets info about how the currently logged in user was authenticated. |
| POST api/Account/SendConfirmationEmail |
Send an email address confirmation email to the currently authenticated user. If the user has already confirmed their email address, no action is taken. |
| GET api/Account/ConfirmEmail?userId={userId}&code={code}&completeUrl={completeUrl} |
Confirm an email address for an account based on userId and email confirmation code. Email address confirmation emails include links to this API. If an error occurs, it will be passed to the email confirmation complete URL as an "error" parameter. Use of this API occurs automatically when confirmation emails are generated. This API is not intended to be called directly. |
| POST api/Account/SendPasswordResetEmail |
Send a password reset email. A password reset code is generated and added to the Reset URL, which is then emailed to the user. The application or web site must present the user with UI to enter a new password, and then use ResetPassword. |
| POST api/Account/ResetPassword |
Resets the password for an account based on user name and password reset code. |
| POST api/Account/GetUserInfo |
Gets information about the current user |
| POST api/Account/UpdateUserInfo |
Update a user's info. |
| POST api/Account/ChangePassword |
Change a user's password. |
| POST api/Account/ChangeEmail |
Changes the user's email address. The email address will be unconfirmed. |
| POST api/Account/RequestEmailChange |
Requests a confirmation email to a new email address. This API can be used if the UI requires the user's email be confirmed, to only update the email address after a confirmation of a new one. |
| GET api/Account/ConfirmEmailChange?userId={userId}&email={email}&code={code}&completeUrl={completeUrl} |
Confirm a requested change of email address, based on userId and email confirmation code. Email address confirmation emails include links to this API. If an error occurs, it will be passed to the email confirmation complete URL as an "error" parameter. Use of this API occurs automatically when confirmation emails are generated. This API is not intended to be called directly. |
| POST api/Account/SetPassword |
Set a password on the account, if none is set. An account without a password can only be logged into via an external login provider. |
| GET api/Account/GetExternalLoginProviders?returnUrl={returnUrl}&generateState={generateState} |
Gets a list of external login providers, including URLs for logging into them. |
| POST api/Account/RegisterExternal |
Register a new user account for a user currently logged in via an external login provider |
| GET api/Account/ExternalLogin?provider={provider}&response_type={response_type}&client_id={client_id}&redirect_uri={redirect_uri}&error={error} |
External login. URLs returned by GetExternalLoginProviders refer to this API. This API is not intended to be called directly. |
| POST api/Account/AddExternalLogin |
Add a successfully logged in external provider to an account. |
| POST api/Account/RemoveExternalLogin |
Remove an external login provider from the current user. |
| POST api/Account/AddAdministrator |
Adds a user to the administrators role |
| POST api/Account/RemoveAdministrator |
Removes a user from the administrators role |
| GET api/Account/ListAdministrators |
Get a list of system administrators |