You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -67,7 +67,7 @@ GET https://HOSTNAME/v1/account/logs
67
67
| --- | --- | --- | --- |
68
68
| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset |[]|
| password | string | New user password. Must be at least 8 chars. ||
97
97
| oldPassword | string | Current user password. Must be at least 8 chars. ||
98
98
99
-
## Update Phone
99
+
## Update phone
100
100
101
101
```http request
102
102
PATCH https://HOSTNAME/v1/account/phone
103
103
```
104
104
105
-
** Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST /account/verification/phone](/docs/client/account#accountCreatePhoneVerification) endpoint to send a confirmation SMS. **
105
+
** Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) endpoint to send a confirmation SMS. **
** Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the [PUT /account/recovery](/docs/client/account#accountUpdateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour. **
142
+
** Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the [PUT /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour. **
143
143
144
144
### Parameters
145
145
@@ -148,13 +148,13 @@ POST https://HOSTNAME/v1/account/recovery
148
148
| email | string | User email. ||
149
149
| url | string | URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API. ||
150
150
151
-
## Create Password Recovery (confirmation)
151
+
## Create password recovery (confirmation)
152
152
153
153
```http request
154
154
PUT https://HOSTNAME/v1/account/recovery
155
155
```
156
156
157
-
** Use this endpoint to complete the user account password reset. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/recovery](/docs/client/account#accountCreateRecovery) endpoint.
157
+
** Use this endpoint to complete the user account password reset. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) endpoint.
158
158
159
159
Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface. **
160
160
@@ -167,23 +167,23 @@ Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/
167
167
| password | string | New user password. Must be at least 8 chars. ||
168
168
| passwordAgain | string | Repeat new user password. Must be at least 8 chars. ||
169
169
170
-
## List Sessions
170
+
## List sessions
171
171
172
172
```http request
173
173
GET https://HOSTNAME/v1/account/sessions
174
174
```
175
175
176
176
** Get the list of active sessions across different devices for the currently logged in user. **
177
177
178
-
## Delete Sessions
178
+
## Delete sessions
179
179
180
180
```http request
181
181
DELETE https://HOSTNAME/v1/account/sessions
182
182
```
183
183
184
184
** Delete all sessions from the user account and remove any sessions cookies from the end client. **
185
185
186
-
## Get Session
186
+
## Get session
187
187
188
188
```http request
189
189
GET https://HOSTNAME/v1/account/sessions/{sessionId}
@@ -197,7 +197,7 @@ GET https://HOSTNAME/v1/account/sessions/{sessionId}
197
197
| --- | --- | --- | --- |
198
198
| sessionId | string |**Required** Session ID. Use the string 'current' to get the current device session. ||
** Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use [Delete Sessions](/docs/client/account#accountDeleteSessions) instead. **
220
+
** Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use [Delete Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) instead. **
221
221
222
222
### Parameters
223
223
224
224
| Field Name | Type | Description | Default |
225
225
| --- | --- | --- | --- |
226
226
| sessionId | string |**Required** Session ID. Use the string 'current' to delete the current device session. ||
227
227
228
-
## Update Status
228
+
## Update status
229
229
230
230
```http request
231
231
PATCH https://HOSTNAME/v1/account/status
232
232
```
233
233
234
234
** Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead. **
235
235
236
-
## Create Email Verification
236
+
## Create email verification
237
237
238
238
```http request
239
239
POST https://HOSTNAME/v1/account/verification
240
240
```
241
241
242
-
** Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](/docs/client/account#accountUpdateEmailVerification). The verification link sent to the user's email address is valid for 7 days.
242
+
** Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.
243
243
244
244
Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.
245
245
**
@@ -250,7 +250,7 @@ Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/
250
250
| --- | --- | --- | --- |
251
251
| url | string | URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API. ||
252
252
253
-
## Create Email Verification (confirmation)
253
+
## Create email verification (confirmation)
254
254
255
255
```http request
256
256
PUT https://HOSTNAME/v1/account/verification
@@ -265,15 +265,15 @@ PUT https://HOSTNAME/v1/account/verification
265
265
| userId | string | User ID. ||
266
266
| secret | string | Valid verification token. ||
267
267
268
-
## Create Phone Verification
268
+
## Create phone verification
269
269
270
270
```http request
271
271
POST https://HOSTNAME/v1/account/verification/phone
272
272
```
273
273
274
-
** Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone) endpoint. Learn more about how to [complete the verification process](/docs/client/account#accountUpdatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes. **
274
+
** Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes. **
275
275
276
-
## Create Phone Verification (confirmation)
276
+
## Create phone verification (confirmation)
277
277
278
278
```http request
279
279
PUT https://HOSTNAME/v1/account/verification/phone
Copy file name to clipboardExpand all lines: docs/avatars.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Avatars Service
2
2
3
-
## Get Browser Icon
3
+
## Get browser icon
4
4
5
5
```http request
6
6
GET https://HOSTNAME/v1/avatars/browsers/{code}
7
7
```
8
8
9
-
** You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use width, height and quality arguments to change the output settings.
9
+
** You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.
10
10
11
11
When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. **
12
12
@@ -19,7 +19,7 @@ When one dimension is specified and the other is 0, the image is scaled with pre
19
19
| height | integer | Image height. Pass an integer between 0 to 2000. Defaults to 100. | 100 |
20
20
| quality | integer | Image quality. Pass an integer between 0 to 100. Defaults to 100. | 100 |
21
21
22
-
## Get Credit Card Icon
22
+
## Get credit card icon
23
23
24
24
```http request
25
25
GET https://HOSTNAME/v1/avatars/credit-cards/{code}
@@ -39,7 +39,7 @@ When one dimension is specified and the other is 0, the image is scaled with pre
39
39
| height | integer | Image height. Pass an integer between 0 to 2000. Defaults to 100. | 100 |
40
40
| quality | integer | Image quality. Pass an integer between 0 to 100. Defaults to 100. | 100 |
41
41
42
-
## Get Favicon
42
+
## Get favicon
43
43
44
44
```http request
45
45
GET https://HOSTNAME/v1/avatars/favicon
@@ -54,13 +54,13 @@ GET https://HOSTNAME/v1/avatars/favicon
54
54
| --- | --- | --- | --- |
55
55
| url | string |**Required** Website URL which you want to fetch the favicon from. ||
56
56
57
-
## Get Country Flag
57
+
## Get country flag
58
58
59
59
```http request
60
60
GET https://HOSTNAME/v1/avatars/flags/{code}
61
61
```
62
62
63
-
** You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) standard.
63
+
** You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
64
64
65
65
When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.
66
66
**
@@ -74,7 +74,7 @@ When one dimension is specified and the other is 0, the image is scaled with pre
74
74
| height | integer | Image height. Pass an integer between 0 to 2000. Defaults to 100. | 100 |
75
75
| quality | integer | Image quality. Pass an integer between 0 to 100. Defaults to 100. | 100 |
76
76
77
-
## Get Image from URL
77
+
## Get image from URL
78
78
79
79
```http request
80
80
GET https://HOSTNAME/v1/avatars/image
@@ -93,7 +93,7 @@ When one dimension is specified and the other is 0, the image is scaled with pre
93
93
| width | integer | Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400. | 400 |
94
94
| height | integer | Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400. | 400 |
95
95
96
-
## Get User Initials
96
+
## Get user initials
97
97
98
98
```http request
99
99
GET https://HOSTNAME/v1/avatars/initials
@@ -115,7 +115,7 @@ When one dimension is specified and the other is 0, the image is scaled with pre
115
115
| height | integer | Image height. Pass an integer between 0 to 2000. Defaults to 100. | 500 |
116
116
| background | string | Changes background color. By default a random color will be picked and stay will persistent to the given name. ||
0 commit comments