1
0
Fork 0
mirror of synced 2024-05-20 20:52:36 +12:00

Moved docs to md files

This commit is contained in:
eldadfux 2019-10-07 20:06:55 +03:00
parent 90be913d33
commit 28b81c7382
60 changed files with 67 additions and 3 deletions

View file

@ -0,0 +1 @@
Delete currently logged in user account.

View file

@ -0,0 +1 @@
Get currently logged in user preferences key-value object.

View file

@ -0,0 +1 @@
Get currently logged in user list of latest security activity logs. Each log returns user IP address, location and date and time of log.

View file

@ -0,0 +1 @@
Get currently logged in user list of active sessions across different devices.

View file

@ -0,0 +1 @@
Get currently logged in user data as JSON object.

View file

@ -0,0 +1 @@
Update currently logged in user account email address. After changing user address, user confirmation status is being reset and a new confirmation mail is sent. For security measures, user password is required to complete this request.

View file

@ -0,0 +1 @@
Update currently logged in user account name.

View file

@ -0,0 +1 @@
Update currently logged in user password. For validation, user is required to pass the password twice.

View file

@ -0,0 +1 @@
Update currently logged in user account preferences. You can pass only the specific settings you wish to update.

View file

@ -1,5 +1,5 @@
Allow the user to login into his account by providing a valid email and password combination. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.
Allow the user to login into his account by providing a valid email and password combination. Use the success and failure arguments to provide a redirect URL\'s back to your app when login is completed.
Please notice that in order to avoid a [Redirect Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.
When accessing this route using JavaScript from the browser, success and failure parameter URLs are required. Appwrite server will respond with a 301 redirect status code and will set the user session cookie. This behavior is enforced because modern browsers are limiting 3rd party cookies in XHR of fetch requests to protect user privacy.
When accessing this route using Javascript from the browser, success and failure parameter URLs are required. Appwrite server will respond with a 301 redirect status code and will set the user session cookie. This behavior is enforced because modern browsers are limiting 3rd party cookies in XHR of fetch requests to protect user privacy.

View file

View file

@ -4,4 +4,4 @@ If registration completes successfully user will be sent with a confirmation ema
Please notice that in order to avoid a [Redirect Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.
When accessing this route using JavaScript from the browser, success and failure parameter URLs are required. Appwrite server will respond with a 301 redirect status code and will set the user session cookie. This behavior is enforced because modern browsers are limiting 3rd party cookies in XHR of fetch requests to protect user privacy.
When accessing this route using Javascript from the browser, success and failure parameter URLs are required. Appwrite server will respond with a 301 redirect status code and will set the user session cookie. This behavior is enforced because modern browsers are limiting 3rd party cookies in XHR of fetch requests to protect user privacy.

View file

@ -0,0 +1 @@
You can use this endpoint to show different browser icons to your users, The code argument receives the browser code as appear in your user /account/sessions endpoint. Use width, height and quality arguments to change the output settings.

View file

@ -0,0 +1 @@
Need to display your users with your billing method or there payment methods? The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.

View file

@ -0,0 +1 @@
Use this endpoint to fetch the favorite icon (AKA favicon) of a any remote website URL.

View file

@ -0,0 +1 @@
You can use this endpoint to show different country flags icons to your users, The code argument receives the a 2 letter country code. Use width, height and quality arguments to change the output settings.

View file

@ -0,0 +1 @@
Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in cases, you want to make sure a 3rd party image is properly served using a TLS protocol.

View file

@ -0,0 +1 @@
Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.

View file

@ -0,0 +1 @@
Create a new Collection.

View file

@ -0,0 +1 @@
Create a new Document.

View file

@ -0,0 +1 @@
Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.

View file

@ -0,0 +1 @@
Delete document by its unique ID. This endpoint deletes only the parent documents, his attributes and relations to other documents. Child documents **will not** be deleted.

View file

@ -0,0 +1 @@
Get collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.

View file

@ -0,0 +1 @@
Get document by its unique ID. This endpoint response returns a JSON object with the document data.

View file

@ -0,0 +1 @@
Get a list of all the user collections. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project collections. [Learn more about different API modes](/docs/modes).

View file

@ -0,0 +1 @@
Get a list of all the user documents. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project documents. [Learn more about different API modes](/docs/modes).

View file

@ -0,0 +1 @@
Update collection by its unique ID.

View file

@ -0,0 +1 @@
List of all countries that are currently members of the EU. You can use the locale header to get the data in supported language. UK brexit date is currently set to 2019-10-31 and will be updated if and when needed.

View file

@ -0,0 +1 @@
List of all countries phone codes. You can use the locale header to get the data in supported language.

View file

@ -0,0 +1 @@
List of all countries. You can use the locale header to get the data in supported language.

View file

@ -0,0 +1 @@
List of all currencies, including currency symol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in supported language.

View file

@ -0,0 +1 @@
Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in supported language.

View file

@ -0,0 +1 @@
Create a new file. The user who creates the file will automatically be assigned to read and write access unless he has passed custom values for read and write arguments.

View file

@ -0,0 +1 @@
Delete a file by its unique ID. Only users with write permissions have access to delete this resource.

View file

@ -0,0 +1 @@
Get file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.

View file

@ -0,0 +1 @@
Get file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets will return file icon image. You can also pass query string arguments for cutting and resizing your preview image.

View file

@ -0,0 +1 @@
Get file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.

View file

@ -0,0 +1 @@
Get file by its unique ID. This endpoint response returns a JSON object with the file metadata.

View file

@ -0,0 +1 @@
Get a list of all the user files. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project files. [Learn more about different API modes](/docs/modes).

View file

@ -0,0 +1 @@
Update file by its unique ID. Only users with write permissions have access to update this resource.

View file

@ -0,0 +1 @@
Use this endpoint to resend your invitation email for a user to join a team.

View file

@ -0,0 +1,5 @@
Use this endpoint to invite a new member to your team. An email with a link to join the team will be sent to the new member email address. If member doesn't exists in the project it will be automatically created.
Use the redirect parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the /teams/{teamId}/memberships/{inviteId}/status endpoint to finally join the user to the team.
Please notice that in order to avoid a [Redirect Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.

View file

@ -0,0 +1 @@
Create a new team. The user who creates the team will automatically be assigned as the owner of the team. The team owner can invite new members, who will be able add new owners and update or delete the team from your project.

View file

@ -0,0 +1 @@
This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member.

View file

@ -0,0 +1 @@
Delete team by its unique ID. Only team owners have write access for this resource.

View file

@ -0,0 +1 @@
Get team members by the team unique ID. All team members have read access for this list of resources.

View file

@ -0,0 +1 @@
Get team by its unique ID. All team members have read access for this resource.

View file

@ -0,0 +1 @@
Get a list of all the current user teams. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project teams. [Learn more about different API modes](/docs/modes).

View file

@ -0,0 +1,5 @@
Use this endpoint to let user accept an invitation to join a team after he is being redirect back to your app from the invitation email. Use the success and failure URL's to redirect users back to your application after the request completes.
Please notice that in order to avoid a [Redirect Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.
When not using the success or failure redirect arguments this endpoint will result with a 200 status code on success and with 401 status error on failure. This behavior was applied to help the web clients deal with browsers who don't allow to set 3rd party HTTP cookies needed for saving the account session token.

View file

@ -0,0 +1 @@
Update team by its unique ID. Only team owners have write access for this resource.

View file

@ -0,0 +1 @@
Create a new user.

View file

@ -0,0 +1 @@
Delete all user sessions by its unique ID.

View file

@ -0,0 +1 @@
Delete user sessions by its unique ID.

View file

@ -0,0 +1 @@
Get user activity logs list by its unique ID.

View file

@ -0,0 +1 @@
Get user preferences by its unique ID.

View file

@ -0,0 +1 @@
Get user sessions list by its unique ID.

View file

@ -0,0 +1 @@
Get user by its unique ID.

View file

@ -0,0 +1 @@
Get a list of all the project users. You can use the query params to filter your results.

View file

@ -0,0 +1 @@
Update user status by its unique ID.