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
| type | string |**Required** Type of authenticator. ||
151
151
152
-
## Create MFA Challenge
152
+
## Create MFA challenge
153
153
154
154
```http request
155
155
POST https://cloud.appwrite.io/v1/account/mfa/challenge
@@ -163,7 +163,7 @@ POST https://cloud.appwrite.io/v1/account/mfa/challenge
163
163
| --- | --- | --- | --- |
164
164
| factor | string | Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`. ||
165
165
166
-
## Create MFA Challenge (confirmation)
166
+
## Create MFA challenge (confirmation)
167
167
168
168
```http request
169
169
PUT https://cloud.appwrite.io/v1/account/mfa/challenge
@@ -178,31 +178,31 @@ PUT https://cloud.appwrite.io/v1/account/mfa/challenge
178
178
| challengeId | string | ID of the challenge. ||
179
179
| otp | string | Valid verification token. ||
180
180
181
-
## List Factors
181
+
## List factors
182
182
183
183
```http request
184
184
GET https://cloud.appwrite.io/v1/account/mfa/factors
185
185
```
186
186
187
187
** List the factors available on the account to be used as a MFA challange. **
188
188
189
-
## Get MFA Recovery Codes
189
+
## Get MFA recovery codes
190
190
191
191
```http request
192
192
GET https://cloud.appwrite.io/v1/account/mfa/recovery-codes
193
193
```
194
194
195
195
** Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes. **
196
196
197
-
## Create MFA Recovery Codes
197
+
## Create MFA recovery codes
198
198
199
199
```http request
200
200
POST https://cloud.appwrite.io/v1/account/mfa/recovery-codes
201
201
```
202
202
203
203
** Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method. **
@@ -469,7 +469,7 @@ A user is limited to 10 active sessions at a time by default. [Learn more about
469
469
POST https://cloud.appwrite.io/v1/account/tokens/magic-url
470
470
```
471
471
472
-
** Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.
472
+
** Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour.
473
473
474
474
A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
Copy file name to clipboardexpand all lines: docs/functions.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ POST https://cloud.appwrite.io/v1/functions
48
48
| templateOwner | string | The name of the owner of the template. ||
49
49
| templateRootDirectory | string | Path to function code in the template repo. ||
50
50
| templateVersion | string | Version (tag) for the repo linked to the function template. ||
51
-
| specification | string | Runtime specification for the function and builds. | s-0.5vcpu-512mb |
51
+
| specification | string | Runtime specification for the function and builds. | s-1vcpu-512mb |
52
52
53
53
## List runtimes
54
54
@@ -110,7 +110,7 @@ PUT https://cloud.appwrite.io/v1/functions/{functionId}
110
110
| providerBranch | string | Production branch for the repo linked to the function ||
111
111
| providerSilentMode | boolean | Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests. ||
112
112
| providerRootDirectory | string | Path to function code in the linked repo. ||
113
-
| specification | string | Runtime specification for the function and builds. | s-0.5vcpu-512mb |
113
+
| specification | string | Runtime specification for the function and builds. | s-1vcpu-512mb |
Copy file name to clipboardexpand all lines: docs/messaging.md
+9-3
Original file line number
Diff line number
Diff line change
@@ -84,16 +84,19 @@ POST https://cloud.appwrite.io/v1/messaging/messages/push
84
84
| topics | array | List of Topic IDs. |[]|
85
85
| users | array | List of User IDs. |[]|
86
86
| targets | array | List of Targets IDs. |[]|
87
-
| data | object | Additional Data for push notification. | {} |
87
+
| data | object | Additional key-value pair data for push notification. | {} |
88
88
| action | string | Action for push notification. ||
89
89
| image | string | Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>. ||
90
90
| icon | string | Icon for push notification. Available only for Android and Web Platform. ||
91
-
| sound | string | Sound for push notification. Available only for Android and IOS Platform. ||
91
+
| sound | string | Sound for push notification. Available only for Android and iOS Platform. ||
92
92
| color | string | Color for push notification. Available only for Android Platform. ||
93
93
| tag | string | Tag for push notification. Available only for Android Platform. ||
94
-
| badge |string| Badge for push notification. Available only for IOS Platform. ||
94
+
| badge |integer| Badge for push notification. Available only for iOS Platform. |-1|
95
95
| draft | boolean | Is message a draft ||
96
96
| scheduledAt | string | Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future. ||
97
+
| contentAvailable | boolean | If set to true, the notification will be delivered in the background. Available only for iOS Platform. ||
98
+
| critical | boolean | If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform. ||
99
+
| priority | string | Set the notification priority. "normal" will consider device state and may not deliver notifications immediately. "high" will always attempt to immediately deliver the notification. | high |
| badge | integer | Badge for push notification. Available only for iOS platforms. ||
125
128
| draft | boolean | Is message a draft ||
126
129
| scheduledAt | string | Scheduled delivery time for message in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future. ||
130
+
| contentAvailable | boolean | If set to true, the notification will be delivered in the background. Available only for iOS Platform. ||
131
+
| critical | boolean | If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform. ||
132
+
| priority | string | Set the notification priority. "normal" will consider device battery state and may send notifications later. "high" will always attempt to immediately deliver the notification. ||
Copy file name to clipboardexpand all lines: docs/storage.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -161,7 +161,7 @@ PUT https://cloud.appwrite.io/v1/storage/buckets/{bucketId}/files/{fileId}
161
161
| name | string | Name of the file ||
162
162
| permissions | array | An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions). ||
GET https://cloud.appwrite.io/v1/teams/{teamId}/memberships
81
81
```
82
82
83
-
** Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. **
83
+
** Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console. **
84
84
85
85
### Parameters
86
86
@@ -123,7 +123,7 @@ Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatShee
123
123
GET https://cloud.appwrite.io/v1/teams/{teamId}/memberships/{membershipId}
124
124
```
125
125
126
-
** Get a team member by the membership unique id. All team members have read access for this resource. **
126
+
** Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console. **
| status | boolean | User Status. To activate the user pass `true` and to block the user pass `false`. ||
531
531
532
-
## List User Targets
532
+
## List user targets
533
533
534
534
```http request
535
535
GET https://cloud.appwrite.io/v1/users/{userId}/targets
@@ -544,7 +544,7 @@ GET https://cloud.appwrite.io/v1/users/{userId}/targets
544
544
| userId | string |**Required** User ID. ||
545
545
| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels |[]|
546
546
547
-
## Create User Target
547
+
## Create user target
548
548
549
549
```http request
550
550
POST https://cloud.appwrite.io/v1/users/{userId}/targets
@@ -563,7 +563,7 @@ POST https://cloud.appwrite.io/v1/users/{userId}/targets
563
563
| providerId | string | Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used. ||
564
564
| name | string | Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23. ||
565
565
566
-
## Get User Target
566
+
## Get user target
567
567
568
568
```http request
569
569
GET https://cloud.appwrite.io/v1/users/{userId}/targets/{targetId}
@@ -578,7 +578,7 @@ GET https://cloud.appwrite.io/v1/users/{userId}/targets/{targetId}
0 commit comments