From 28b81c7382020cefddea561a66bd56dc1e5add56 Mon Sep 17 00:00:00 2001 From: eldadfux Date: Mon, 7 Oct 2019 20:06:55 +0300 Subject: [PATCH] Moved docs to md files --- docs/references/account/delete.md | 1 + docs/references/account/get-prefs.md | 1 + docs/references/account/get-security.md | 1 + docs/references/account/get-sessions.md | 1 + docs/references/account/get.md | 1 + docs/references/account/update-email.md | 1 + docs/references/account/update-name.md | 1 + docs/references/account/update-password.md | 1 + docs/references/account/update-prefs.md | 1 + docs/references/auth/login.md | 4 ++-- docs/references/auth/oauth.md | 0 docs/references/auth/register.md | 2 +- docs/references/avatars/get-browser.md | 1 + docs/references/avatars/get-credit-card.md | 1 + docs/references/avatars/get-favicon.md | 1 + docs/references/avatars/get-flag.md | 1 + docs/references/avatars/get-image.md | 1 + docs/references/avatars/get-qr.md | 1 + docs/references/database/create-collection.md | 1 + docs/references/database/create-document.md | 1 + docs/references/database/delete-collection.md | 1 + docs/references/database/delete-document.md | 1 + docs/references/database/get-collection.md | 1 + docs/references/database/get-document.md | 1 + docs/references/database/list-collections.md | 1 + docs/references/database/list-documents.md | 1 + docs/references/database/update-collection.md | 1 + docs/references/database/update-document.md | 0 docs/references/locale/get-countries-eu.md | 1 + docs/references/locale/get-countries-phones.md | 1 + docs/references/locale/get-countries.md | 1 + docs/references/locale/get-currencies.md | 1 + docs/references/locale/get-locale.md | 1 + docs/references/storage/create-file.md | 1 + docs/references/storage/delete-file.md | 1 + docs/references/storage/get-file-download.md | 1 + docs/references/storage/get-file-preview.md | 1 + docs/references/storage/get-file-view.md | 1 + docs/references/storage/get-file.md | 1 + docs/references/storage/list-files.md | 1 + docs/references/storage/update-file.md | 1 + docs/references/teams/create-team-membership-resend.md | 1 + docs/references/teams/create-team-membership.md | 5 +++++ docs/references/teams/create-team.md | 1 + docs/references/teams/delete-team-membership.md | 1 + docs/references/teams/delete-team.md | 1 + docs/references/teams/get-team-members.md | 1 + docs/references/teams/get-team.md | 1 + docs/references/teams/list-teams.md | 1 + docs/references/teams/update-team-membership-status.md | 5 +++++ docs/references/teams/update-team.md | 1 + docs/references/users/create-user.md | 1 + docs/references/users/delete-user-sessions.md | 1 + docs/references/users/delete-users-session.md | 1 + docs/references/users/get-user-logs.md | 1 + docs/references/users/get-user-prefs.md | 1 + docs/references/users/get-user-sessions.md | 1 + docs/references/users/get-user.md | 1 + docs/references/users/list-users.md | 1 + docs/references/users/update-user-status.md | 1 + 60 files changed, 67 insertions(+), 3 deletions(-) create mode 100644 docs/references/account/delete.md create mode 100644 docs/references/account/get-prefs.md create mode 100644 docs/references/account/get-security.md create mode 100644 docs/references/account/get-sessions.md create mode 100644 docs/references/account/get.md create mode 100644 docs/references/account/update-email.md create mode 100644 docs/references/account/update-name.md create mode 100644 docs/references/account/update-password.md create mode 100644 docs/references/account/update-prefs.md create mode 100644 docs/references/auth/oauth.md create mode 100644 docs/references/avatars/get-browser.md create mode 100644 docs/references/avatars/get-credit-card.md create mode 100644 docs/references/avatars/get-favicon.md create mode 100644 docs/references/avatars/get-flag.md create mode 100644 docs/references/avatars/get-image.md create mode 100644 docs/references/avatars/get-qr.md create mode 100644 docs/references/database/create-collection.md create mode 100644 docs/references/database/create-document.md create mode 100644 docs/references/database/delete-collection.md create mode 100644 docs/references/database/delete-document.md create mode 100644 docs/references/database/get-collection.md create mode 100644 docs/references/database/get-document.md create mode 100644 docs/references/database/list-collections.md create mode 100644 docs/references/database/list-documents.md create mode 100644 docs/references/database/update-collection.md create mode 100644 docs/references/database/update-document.md create mode 100644 docs/references/locale/get-countries-eu.md create mode 100644 docs/references/locale/get-countries-phones.md create mode 100644 docs/references/locale/get-countries.md create mode 100644 docs/references/locale/get-currencies.md create mode 100644 docs/references/locale/get-locale.md create mode 100644 docs/references/storage/create-file.md create mode 100644 docs/references/storage/delete-file.md create mode 100644 docs/references/storage/get-file-download.md create mode 100644 docs/references/storage/get-file-preview.md create mode 100644 docs/references/storage/get-file-view.md create mode 100644 docs/references/storage/get-file.md create mode 100644 docs/references/storage/list-files.md create mode 100644 docs/references/storage/update-file.md create mode 100644 docs/references/teams/create-team-membership-resend.md create mode 100644 docs/references/teams/create-team-membership.md create mode 100644 docs/references/teams/create-team.md create mode 100644 docs/references/teams/delete-team-membership.md create mode 100644 docs/references/teams/delete-team.md create mode 100644 docs/references/teams/get-team-members.md create mode 100644 docs/references/teams/get-team.md create mode 100644 docs/references/teams/list-teams.md create mode 100644 docs/references/teams/update-team-membership-status.md create mode 100644 docs/references/teams/update-team.md create mode 100644 docs/references/users/create-user.md create mode 100644 docs/references/users/delete-user-sessions.md create mode 100644 docs/references/users/delete-users-session.md create mode 100644 docs/references/users/get-user-logs.md create mode 100644 docs/references/users/get-user-prefs.md create mode 100644 docs/references/users/get-user-sessions.md create mode 100644 docs/references/users/get-user.md create mode 100644 docs/references/users/list-users.md create mode 100644 docs/references/users/update-user-status.md diff --git a/docs/references/account/delete.md b/docs/references/account/delete.md new file mode 100644 index 0000000000..9fbad88cb5 --- /dev/null +++ b/docs/references/account/delete.md @@ -0,0 +1 @@ +Delete currently logged in user account. \ No newline at end of file diff --git a/docs/references/account/get-prefs.md b/docs/references/account/get-prefs.md new file mode 100644 index 0000000000..5cea863e31 --- /dev/null +++ b/docs/references/account/get-prefs.md @@ -0,0 +1 @@ +Get currently logged in user preferences key-value object. \ No newline at end of file diff --git a/docs/references/account/get-security.md b/docs/references/account/get-security.md new file mode 100644 index 0000000000..5cd2a4b87e --- /dev/null +++ b/docs/references/account/get-security.md @@ -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. \ No newline at end of file diff --git a/docs/references/account/get-sessions.md b/docs/references/account/get-sessions.md new file mode 100644 index 0000000000..e944fd3675 --- /dev/null +++ b/docs/references/account/get-sessions.md @@ -0,0 +1 @@ +Get currently logged in user list of active sessions across different devices. \ No newline at end of file diff --git a/docs/references/account/get.md b/docs/references/account/get.md new file mode 100644 index 0000000000..f62b1f52bf --- /dev/null +++ b/docs/references/account/get.md @@ -0,0 +1 @@ +Get currently logged in user data as JSON object. \ No newline at end of file diff --git a/docs/references/account/update-email.md b/docs/references/account/update-email.md new file mode 100644 index 0000000000..d99b9b4a1d --- /dev/null +++ b/docs/references/account/update-email.md @@ -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. \ No newline at end of file diff --git a/docs/references/account/update-name.md b/docs/references/account/update-name.md new file mode 100644 index 0000000000..1d62171959 --- /dev/null +++ b/docs/references/account/update-name.md @@ -0,0 +1 @@ +Update currently logged in user account name. \ No newline at end of file diff --git a/docs/references/account/update-password.md b/docs/references/account/update-password.md new file mode 100644 index 0000000000..207fedab1f --- /dev/null +++ b/docs/references/account/update-password.md @@ -0,0 +1 @@ +Update currently logged in user password. For validation, user is required to pass the password twice. \ No newline at end of file diff --git a/docs/references/account/update-prefs.md b/docs/references/account/update-prefs.md new file mode 100644 index 0000000000..cdfbdf9f04 --- /dev/null +++ b/docs/references/account/update-prefs.md @@ -0,0 +1 @@ +Update currently logged in user account preferences. You can pass only the specific settings you wish to update. \ No newline at end of file diff --git a/docs/references/auth/login.md b/docs/references/auth/login.md index 1bbd0fbdb7..5c8f1e7a4a 100644 --- a/docs/references/auth/login.md +++ b/docs/references/auth/login.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/references/auth/oauth.md b/docs/references/auth/oauth.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/references/auth/register.md b/docs/references/auth/register.md index a5195eef10..4c6768f1a4 100644 --- a/docs/references/auth/register.md +++ b/docs/references/auth/register.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/references/avatars/get-browser.md b/docs/references/avatars/get-browser.md new file mode 100644 index 0000000000..8b1032d59a --- /dev/null +++ b/docs/references/avatars/get-browser.md @@ -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. \ No newline at end of file diff --git a/docs/references/avatars/get-credit-card.md b/docs/references/avatars/get-credit-card.md new file mode 100644 index 0000000000..c94b1cabbe --- /dev/null +++ b/docs/references/avatars/get-credit-card.md @@ -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. \ No newline at end of file diff --git a/docs/references/avatars/get-favicon.md b/docs/references/avatars/get-favicon.md new file mode 100644 index 0000000000..889b046e2e --- /dev/null +++ b/docs/references/avatars/get-favicon.md @@ -0,0 +1 @@ +Use this endpoint to fetch the favorite icon (AKA favicon) of a any remote website URL. \ No newline at end of file diff --git a/docs/references/avatars/get-flag.md b/docs/references/avatars/get-flag.md new file mode 100644 index 0000000000..81cdb1bbac --- /dev/null +++ b/docs/references/avatars/get-flag.md @@ -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. \ No newline at end of file diff --git a/docs/references/avatars/get-image.md b/docs/references/avatars/get-image.md new file mode 100644 index 0000000000..981d10675c --- /dev/null +++ b/docs/references/avatars/get-image.md @@ -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. \ No newline at end of file diff --git a/docs/references/avatars/get-qr.md b/docs/references/avatars/get-qr.md new file mode 100644 index 0000000000..54c6c3588a --- /dev/null +++ b/docs/references/avatars/get-qr.md @@ -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. \ No newline at end of file diff --git a/docs/references/database/create-collection.md b/docs/references/database/create-collection.md new file mode 100644 index 0000000000..5896acd681 --- /dev/null +++ b/docs/references/database/create-collection.md @@ -0,0 +1 @@ +Create a new Collection. \ No newline at end of file diff --git a/docs/references/database/create-document.md b/docs/references/database/create-document.md new file mode 100644 index 0000000000..d2ab330bc5 --- /dev/null +++ b/docs/references/database/create-document.md @@ -0,0 +1 @@ +Create a new Document. \ No newline at end of file diff --git a/docs/references/database/delete-collection.md b/docs/references/database/delete-collection.md new file mode 100644 index 0000000000..90f7aa6aa5 --- /dev/null +++ b/docs/references/database/delete-collection.md @@ -0,0 +1 @@ +Delete a collection by its unique ID. Only users with write permissions have access to delete this resource. \ No newline at end of file diff --git a/docs/references/database/delete-document.md b/docs/references/database/delete-document.md new file mode 100644 index 0000000000..2545821205 --- /dev/null +++ b/docs/references/database/delete-document.md @@ -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. \ No newline at end of file diff --git a/docs/references/database/get-collection.md b/docs/references/database/get-collection.md new file mode 100644 index 0000000000..db0823beb9 --- /dev/null +++ b/docs/references/database/get-collection.md @@ -0,0 +1 @@ +Get collection by its unique ID. This endpoint response returns a JSON object with the collection metadata. \ No newline at end of file diff --git a/docs/references/database/get-document.md b/docs/references/database/get-document.md new file mode 100644 index 0000000000..1aa54e6d28 --- /dev/null +++ b/docs/references/database/get-document.md @@ -0,0 +1 @@ +Get document by its unique ID. This endpoint response returns a JSON object with the document data. \ No newline at end of file diff --git a/docs/references/database/list-collections.md b/docs/references/database/list-collections.md new file mode 100644 index 0000000000..d1bf657dae --- /dev/null +++ b/docs/references/database/list-collections.md @@ -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). \ No newline at end of file diff --git a/docs/references/database/list-documents.md b/docs/references/database/list-documents.md new file mode 100644 index 0000000000..c6e210e8c8 --- /dev/null +++ b/docs/references/database/list-documents.md @@ -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). \ No newline at end of file diff --git a/docs/references/database/update-collection.md b/docs/references/database/update-collection.md new file mode 100644 index 0000000000..d9ee36a305 --- /dev/null +++ b/docs/references/database/update-collection.md @@ -0,0 +1 @@ +Update collection by its unique ID. \ No newline at end of file diff --git a/docs/references/database/update-document.md b/docs/references/database/update-document.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/references/locale/get-countries-eu.md b/docs/references/locale/get-countries-eu.md new file mode 100644 index 0000000000..b42d5bbc32 --- /dev/null +++ b/docs/references/locale/get-countries-eu.md @@ -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. \ No newline at end of file diff --git a/docs/references/locale/get-countries-phones.md b/docs/references/locale/get-countries-phones.md new file mode 100644 index 0000000000..6aeecfcaa0 --- /dev/null +++ b/docs/references/locale/get-countries-phones.md @@ -0,0 +1 @@ +List of all countries phone codes. You can use the locale header to get the data in supported language. \ No newline at end of file diff --git a/docs/references/locale/get-countries.md b/docs/references/locale/get-countries.md new file mode 100644 index 0000000000..c708dce6dc --- /dev/null +++ b/docs/references/locale/get-countries.md @@ -0,0 +1 @@ +List of all countries. You can use the locale header to get the data in supported language. \ No newline at end of file diff --git a/docs/references/locale/get-currencies.md b/docs/references/locale/get-currencies.md new file mode 100644 index 0000000000..4214d9c555 --- /dev/null +++ b/docs/references/locale/get-currencies.md @@ -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. \ No newline at end of file diff --git a/docs/references/locale/get-locale.md b/docs/references/locale/get-locale.md new file mode 100644 index 0000000000..d7a1e22849 --- /dev/null +++ b/docs/references/locale/get-locale.md @@ -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. \ No newline at end of file diff --git a/docs/references/storage/create-file.md b/docs/references/storage/create-file.md new file mode 100644 index 0000000000..7fd6c5a492 --- /dev/null +++ b/docs/references/storage/create-file.md @@ -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. \ No newline at end of file diff --git a/docs/references/storage/delete-file.md b/docs/references/storage/delete-file.md new file mode 100644 index 0000000000..1464665812 --- /dev/null +++ b/docs/references/storage/delete-file.md @@ -0,0 +1 @@ +Delete a file by its unique ID. Only users with write permissions have access to delete this resource. \ No newline at end of file diff --git a/docs/references/storage/get-file-download.md b/docs/references/storage/get-file-download.md new file mode 100644 index 0000000000..11cb96a9f5 --- /dev/null +++ b/docs/references/storage/get-file-download.md @@ -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. \ No newline at end of file diff --git a/docs/references/storage/get-file-preview.md b/docs/references/storage/get-file-preview.md new file mode 100644 index 0000000000..fd818d92cf --- /dev/null +++ b/docs/references/storage/get-file-preview.md @@ -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. \ No newline at end of file diff --git a/docs/references/storage/get-file-view.md b/docs/references/storage/get-file-view.md new file mode 100644 index 0000000000..4bb5abb3c7 --- /dev/null +++ b/docs/references/storage/get-file-view.md @@ -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. \ No newline at end of file diff --git a/docs/references/storage/get-file.md b/docs/references/storage/get-file.md new file mode 100644 index 0000000000..56db5c8457 --- /dev/null +++ b/docs/references/storage/get-file.md @@ -0,0 +1 @@ +Get file by its unique ID. This endpoint response returns a JSON object with the file metadata. \ No newline at end of file diff --git a/docs/references/storage/list-files.md b/docs/references/storage/list-files.md new file mode 100644 index 0000000000..a53d6baf79 --- /dev/null +++ b/docs/references/storage/list-files.md @@ -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). \ No newline at end of file diff --git a/docs/references/storage/update-file.md b/docs/references/storage/update-file.md new file mode 100644 index 0000000000..abc44a782c --- /dev/null +++ b/docs/references/storage/update-file.md @@ -0,0 +1 @@ +Update file by its unique ID. Only users with write permissions have access to update this resource. \ No newline at end of file diff --git a/docs/references/teams/create-team-membership-resend.md b/docs/references/teams/create-team-membership-resend.md new file mode 100644 index 0000000000..8ba2a913d3 --- /dev/null +++ b/docs/references/teams/create-team-membership-resend.md @@ -0,0 +1 @@ +Use this endpoint to resend your invitation email for a user to join a team. \ No newline at end of file diff --git a/docs/references/teams/create-team-membership.md b/docs/references/teams/create-team-membership.md new file mode 100644 index 0000000000..2edba8cd68 --- /dev/null +++ b/docs/references/teams/create-team-membership.md @@ -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. \ No newline at end of file diff --git a/docs/references/teams/create-team.md b/docs/references/teams/create-team.md new file mode 100644 index 0000000000..91bd09e8f9 --- /dev/null +++ b/docs/references/teams/create-team.md @@ -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. \ No newline at end of file diff --git a/docs/references/teams/delete-team-membership.md b/docs/references/teams/delete-team-membership.md new file mode 100644 index 0000000000..e8c97e63ee --- /dev/null +++ b/docs/references/teams/delete-team-membership.md @@ -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. \ No newline at end of file diff --git a/docs/references/teams/delete-team.md b/docs/references/teams/delete-team.md new file mode 100644 index 0000000000..a9e48c5a43 --- /dev/null +++ b/docs/references/teams/delete-team.md @@ -0,0 +1 @@ +Delete team by its unique ID. Only team owners have write access for this resource. \ No newline at end of file diff --git a/docs/references/teams/get-team-members.md b/docs/references/teams/get-team-members.md new file mode 100644 index 0000000000..b5a33667d9 --- /dev/null +++ b/docs/references/teams/get-team-members.md @@ -0,0 +1 @@ +Get team members by the team unique ID. All team members have read access for this list of resources. \ No newline at end of file diff --git a/docs/references/teams/get-team.md b/docs/references/teams/get-team.md new file mode 100644 index 0000000000..eda8865e78 --- /dev/null +++ b/docs/references/teams/get-team.md @@ -0,0 +1 @@ +Get team by its unique ID. All team members have read access for this resource. \ No newline at end of file diff --git a/docs/references/teams/list-teams.md b/docs/references/teams/list-teams.md new file mode 100644 index 0000000000..ff8b90dd99 --- /dev/null +++ b/docs/references/teams/list-teams.md @@ -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). \ No newline at end of file diff --git a/docs/references/teams/update-team-membership-status.md b/docs/references/teams/update-team-membership-status.md new file mode 100644 index 0000000000..11eaf8ef88 --- /dev/null +++ b/docs/references/teams/update-team-membership-status.md @@ -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. \ No newline at end of file diff --git a/docs/references/teams/update-team.md b/docs/references/teams/update-team.md new file mode 100644 index 0000000000..219989f0cd --- /dev/null +++ b/docs/references/teams/update-team.md @@ -0,0 +1 @@ +Update team by its unique ID. Only team owners have write access for this resource. \ No newline at end of file diff --git a/docs/references/users/create-user.md b/docs/references/users/create-user.md new file mode 100644 index 0000000000..d7267ae8bf --- /dev/null +++ b/docs/references/users/create-user.md @@ -0,0 +1 @@ +Create a new user. \ No newline at end of file diff --git a/docs/references/users/delete-user-sessions.md b/docs/references/users/delete-user-sessions.md new file mode 100644 index 0000000000..7c78dcd637 --- /dev/null +++ b/docs/references/users/delete-user-sessions.md @@ -0,0 +1 @@ +Delete all user sessions by its unique ID. \ No newline at end of file diff --git a/docs/references/users/delete-users-session.md b/docs/references/users/delete-users-session.md new file mode 100644 index 0000000000..7ce030a4a3 --- /dev/null +++ b/docs/references/users/delete-users-session.md @@ -0,0 +1 @@ +Delete user sessions by its unique ID. \ No newline at end of file diff --git a/docs/references/users/get-user-logs.md b/docs/references/users/get-user-logs.md new file mode 100644 index 0000000000..e188651e80 --- /dev/null +++ b/docs/references/users/get-user-logs.md @@ -0,0 +1 @@ +Get user activity logs list by its unique ID. \ No newline at end of file diff --git a/docs/references/users/get-user-prefs.md b/docs/references/users/get-user-prefs.md new file mode 100644 index 0000000000..0a704cfa34 --- /dev/null +++ b/docs/references/users/get-user-prefs.md @@ -0,0 +1 @@ +Get user preferences by its unique ID. \ No newline at end of file diff --git a/docs/references/users/get-user-sessions.md b/docs/references/users/get-user-sessions.md new file mode 100644 index 0000000000..acb9005302 --- /dev/null +++ b/docs/references/users/get-user-sessions.md @@ -0,0 +1 @@ +Get user sessions list by its unique ID. \ No newline at end of file diff --git a/docs/references/users/get-user.md b/docs/references/users/get-user.md new file mode 100644 index 0000000000..60cdf21cac --- /dev/null +++ b/docs/references/users/get-user.md @@ -0,0 +1 @@ +Get user by its unique ID. \ No newline at end of file diff --git a/docs/references/users/list-users.md b/docs/references/users/list-users.md new file mode 100644 index 0000000000..fa7855bc22 --- /dev/null +++ b/docs/references/users/list-users.md @@ -0,0 +1 @@ +Get a list of all the project users. You can use the query params to filter your results. \ No newline at end of file diff --git a/docs/references/users/update-user-status.md b/docs/references/users/update-user-status.md new file mode 100644 index 0000000000..fc334c322b --- /dev/null +++ b/docs/references/users/update-user-status.md @@ -0,0 +1 @@ +Update user status by its unique ID. \ No newline at end of file