Class: Appwrite::Account

Inherits:
Service show all
Defined in:
lib/appwrite/services/account.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Account

Returns a new instance of Account.



6
7
8
 
# File 'lib/appwrite/services/account.rb', line 6

def initialize(client)
    @client = client
end

Instance Method Details

#create(user_id:, email:, password:, name: nil) ⇒ User

Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [/account/verfication](appwrite.io/docs/references/cloud/client-web/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](appwrite.io/docs/references/cloud/client-web/account#createEmailSession).

Parameters:

  • user_id (String) —

    User ID. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

  • email (String) —

    User email.

  • password (String) —

    New user password. Must be between 8 and 256 chars.

  • name (String) (defaults to: nil) —

    User name. Max length: 128 chars.

Returns:

  • (User) 


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/appwrite/services/account.rb', line 46

def create(user_id:, email:, password:, name: nil)
    api_path = '/account'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if email.nil?
      raise Appwrite::Exception.new('Missing required parameter: "email"')
    end

    if password.nil?
      raise Appwrite::Exception.new('Missing required parameter: "password"')
    end

    api_params = {
        userId: user_id,
        email: email,
        password: password,
        name: name,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#create_anonymous_session ⇒ Session

Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](appwrite.io/docs/references/cloud/client-web/account#updateEmail) or create an [OAuth2 session](appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session).

Returns:

  • (Session) 


829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/appwrite/services/account.rb', line 829

def create_anonymous_session()
    api_path = '/account/sessions/anonymous'

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Session
    )
end

#create_email_password_session(email:, password:) ⇒ Session

Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.

A user is limited to 10 active sessions at a time by default. [Learn more about session limits](appwrite.io/docs/authentication-security#limits).

Parameters:

  • email (String) —

    User email.

  • password (String) —

    User password. Must be at least 8 chars.

Returns:

  • (Session) 


859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/appwrite/services/account.rb', line 859

def create_email_password_session(email:, password:)
    api_path = '/account/sessions/email'

    if email.nil?
      raise Appwrite::Exception.new('Missing required parameter: "email"')
    end

    if password.nil?
      raise Appwrite::Exception.new('Missing required parameter: "password"')
    end

    api_params = {
        email: email,
        password: password,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Session
    )
end

#create_email_token(user_id:, email:, phrase: nil) ⇒ Token

Sends the user an email with a secret key for creating a session. If the email address has never been used, a **new account is created** using the provided ‘userId`. Otherwise, if the email address is already attached to an account, the **user ID is ignored**. Then, the user will receive an email with the one-time password. Use the returned user ID and secret and submit a request to the [POST /v1/account/sessions/token](appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The secret sent to the user’s email is valid for 15 minutes.

A user is limited to 10 active sessions at a time by default. [Learn more about session limits](appwrite.io/docs/authentication-security#limits).

Parameters:

  • user_id (String) —

    User ID. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.

  • email (String) —

    User email.

  • [] —

    phrase Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.

Returns:

  • (Token) 


1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/appwrite/services/account.rb', line 1142

def create_email_token(user_id:, email:, phrase: nil)
    api_path = '/account/tokens/email'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if email.nil?
      raise Appwrite::Exception.new('Missing required parameter: "email"')
    end

    api_params = {
        userId: user_id,
        email: email,
        phrase: phrase,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#create_email_verification(url:) ⇒ Token

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](appwrite.io/docs/references/cloud/client-web/account#updateVerification). The verification link sent to the user’s email address is valid for 7 days.

Please note that in order to avoid a [Redirect Attack](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.

Parameters:

Returns:

  • (Token) 


1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'lib/appwrite/services/account.rb', line 1334

def create_email_verification(url:)
    api_path = '/account/verifications/email'

    if url.nil?
      raise Appwrite::Exception.new('Missing required parameter: "url"')
    end

    api_params = {
        url: url,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#create_jwt ⇒ Jwt

Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.

Returns:

  • (Jwt) 


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/appwrite/services/account.rb', line 185

def create_jwt()
    api_path = '/account/jwts'

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Jwt
    )
end

#create_magic_url_token(user_id:, email:, url: nil, phrase: nil) ⇒ Token

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](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.

A user is limited to 10 active sessions at a time by default. [Learn more about session limits](appwrite.io/docs/authentication-security#limits).

Parameters:

  • user_id (String) —

    Unique Id. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.

  • email (String) —

    User email.

  • url (String) (defaults to: nil) —

    URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.

  • [] —

    phrase Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.

Returns:

  • (Token) 


1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'lib/appwrite/services/account.rb', line 1193

def create_magic_url_token(user_id:, email:, url: nil, phrase: nil)
    api_path = '/account/tokens/magic-url'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if email.nil?
      raise Appwrite::Exception.new('Missing required parameter: "email"')
    end

    api_params = {
        userId: user_id,
        email: email,
        url: url,
        phrase: phrase,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#create_mfa_authenticator(type:) ⇒ MfaType

Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) method.

Parameters:

  • type (AuthenticatorType) —

    Type of authenticator. Must be ‘totp`

Returns:

  • (MfaType) 


268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/appwrite/services/account.rb', line 268

def create_mfa_authenticator(type:)
    api_path = '/account/mfa/authenticators/{type}'
        .gsub('{type}', type)

    if type.nil?
      raise Appwrite::Exception.new('Missing required parameter: "type"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::MfaType
    )
end

#create_mfa_challenge(factor:) ⇒ MfaChallenge

Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method.

Parameters:

  • factor (AuthenticationFactor) —

    Factor used for verification. Must be one of following: ‘email`, `phone`, `totp`, `recoveryCode`.

Returns:

  • (MfaChallenge) 


364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/appwrite/services/account.rb', line 364

def create_mfa_challenge(factor:)
    api_path = '/account/mfa/challenges'

    if factor.nil?
      raise Appwrite::Exception.new('Missing required parameter: "factor"')
    end

    api_params = {
        factor: factor,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::MfaChallenge
    )
end

#create_mfa_recovery_codes ⇒ MfaRecoveryCodes

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.

Returns:

  • (MfaRecoveryCodes) 


482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/appwrite/services/account.rb', line 482

def create_mfa_recovery_codes()
    api_path = '/account/mfa/recovery-codes'

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::MfaRecoveryCodes
    )
end

#create_o_auth2_token(provider:, success: nil, failure: nil, scopes: nil) ⇒ Object

Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL’s back to your app when login is completed.

If authentication succeeds, ‘userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint.

A user is limited to 10 active sessions at a time by default. [Learn more about session limits](appwrite.io/docs/authentication-security#limits).

Parameters:

  • provider (OAuthProvider) —

    OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.

  • success (String) (defaults to: nil) —

    URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project’s platform list are allowed. This requirement helps to prevent an [open redirect](cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.

  • failure (String) (defaults to: nil) —

    URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project’s platform list are allowed. This requirement helps to prevent an [open redirect](cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.

  • scopes (Array) (defaults to: nil) —

    A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.

Returns:



1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
 
# File 'lib/appwrite/services/account.rb', line 1245

def create_o_auth2_token(provider:, success: nil, failure: nil, scopes: nil)
    api_path = '/account/tokens/oauth2/{provider}'
        .gsub('{provider}', provider)

    if provider.nil?
      raise Appwrite::Exception.new('Missing required parameter: "provider"')
    end

    api_params = {
        success: success,
        failure: failure,
        scopes: scopes,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: "location"
    )
end

#create_phone_token(user_id:, phone:) ⇒ Token

Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST /v1/account/sessions/token](appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The secret sent to the user’s phone is valid for 15 minutes.

A user is limited to 10 active sessions at a time by default. [Learn more about session limits](appwrite.io/docs/authentication-security#limits).

Parameters:

  • user_id (String) —

    Unique Id. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.

  • phone (String) —

    Phone number. Format this number with a leading ‘+’ and a country code, e.g., +16175551212.

Returns:

  • (Token) 


1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'lib/appwrite/services/account.rb', line 1286

def create_phone_token(user_id:, phone:)
    api_path = '/account/tokens/phone'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if phone.nil?
      raise Appwrite::Exception.new('Missing required parameter: "phone"')
    end

    api_params = {
        userId: user_id,
        phone: phone,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#create_phone_verification ⇒ Token

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](appwrite.io/docs/references/cloud/client-web/account#updatePhone) endpoint. Learn more about how to [complete the verification process](appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). The verification code sent to the user’s phone number is valid for 15 minutes.

Returns:

  • (Token) 


1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
 
# File 'lib/appwrite/services/account.rb', line 1494

def create_phone_verification()
    api_path = '/account/verifications/phone'

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#create_recovery(email:, url:) ⇒ Token

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](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.

Parameters:

Returns:

  • (Token) 


694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/appwrite/services/account.rb', line 694

def create_recovery(email:, url:)
    api_path = '/account/recovery'

    if email.nil?
      raise Appwrite::Exception.new('Missing required parameter: "email"')
    end

    if url.nil?
      raise Appwrite::Exception.new('Missing required parameter: "url"')
    end

    api_params = {
        email: email,
        url: url,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#create_session(user_id:, secret:) ⇒ Session

Use this endpoint to create a session from token. Provide the userId and secret parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.

Parameters:

  • user_id (String) —

    User ID. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

  • secret (String) —

    Secret of a token generated by login methods. For example, the ‘createMagicURLToken` or `createPhoneToken` methods.

Returns:

  • (Session) 


976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/appwrite/services/account.rb', line 976

def create_session(user_id:, secret:)
    api_path = '/account/sessions/token'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if secret.nil?
      raise Appwrite::Exception.new('Missing required parameter: "secret"')
    end

    api_params = {
        userId: user_id,
        secret: secret,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Session
    )
end

#create_verification(url:) ⇒ Token

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘Account.createEmailVerification` instead.

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](appwrite.io/docs/references/cloud/client-web/account#updateVerification). The verification link sent to the user’s email address is valid for 7 days.

Please note that in order to avoid a [Redirect Attack](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.

Parameters:

Returns:

  • (Token) 


1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/appwrite/services/account.rb', line 1380

def create_verification(url:)
    api_path = '/account/verifications/email'

    if url.nil?
      raise Appwrite::Exception.new('Missing required parameter: "url"')
    end

    api_params = {
        url: url,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#delete_identity(identity_id:) ⇒ Object

Delete an identity by its unique ID.

Parameters:

  • identity_id (String) —

    Identity ID.

Returns:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/appwrite/services/account.rb', line 154

def delete_identity(identity_id:)
    api_path = '/account/identities/{identityId}'
        .gsub('{identityId}', identity_id)

    if identity_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "identityId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_mfa_authenticator(type:) ⇒ Object

Delete an authenticator for a user by ID.

Parameters:

  • type (AuthenticatorType) —

    Type of authenticator.

Returns:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/appwrite/services/account.rb', line 334

def delete_mfa_authenticator(type:)
    api_path = '/account/mfa/authenticators/{type}'
        .gsub('{type}', type)

    if type.nil?
      raise Appwrite::Exception.new('Missing required parameter: "type"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_session(session_id:) ⇒ Object

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](appwrite.io/docs/references/cloud/client-web/account#deleteSessions) instead.

Parameters:

  • session_id (String) —

    Session ID. Use the string ‘current’ to delete the current device session.

Returns:



1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/appwrite/services/account.rb', line 1074

def delete_session(session_id:)
    api_path = '/account/sessions/{sessionId}'
        .gsub('{sessionId}', session_id)

    if session_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_sessions ⇒ Object

Delete all sessions from the user account and remove any sessions cookies from the end client.

Returns:



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/appwrite/services/account.rb', line 801

def delete_sessions()
    api_path = '/account/sessions'

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#get ⇒ User

Get the currently logged in user.

Returns:

  • (User) 


14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/appwrite/services/account.rb', line 14

def get()
    api_path = '/account'

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#get_mfa_recovery_codes ⇒ MfaRecoveryCodes

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.

Returns:

  • (MfaRecoveryCodes) 


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/appwrite/services/account.rb', line 456

def get_mfa_recovery_codes()
    api_path = '/account/mfa/recovery-codes'

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::MfaRecoveryCodes
    )
end

#get_prefs ⇒ Preferences

Get the preferences as a key-value object for the currently logged in user.

Returns:

  • (Preferences) 


632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/appwrite/services/account.rb', line 632

def get_prefs()
    api_path = '/account/prefs'

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Preferences
    )
end

#get_session(session_id:) ⇒ Session

Use this endpoint to get a logged in user’s session using a Session ID. Inputting ‘current’ will return the current session being used.

Parameters:

  • session_id (String) —

    Session ID. Use the string ‘current’ to get the current device session.

Returns:

  • (Session) 


1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/appwrite/services/account.rb', line 1011

def get_session(session_id:)
    api_path = '/account/sessions/{sessionId}'
        .gsub('{sessionId}', session_id)

    if session_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Session
    )
end

#list_identities(queries: nil, total: nil) ⇒ IdentityList

Get the list of identities for the currently logged in user.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (IdentityList) 


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/appwrite/services/account.rb', line 129

def list_identities(queries: nil, total: nil)
    api_path = '/account/identities'

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::IdentityList
    )
end

#list_logs(queries: nil, total: nil) ⇒ LogList

Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Only supported methods are limit and offset

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (LogList) 


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/appwrite/services/account.rb', line 211

def list_logs(queries: nil, total: nil)
    api_path = '/account/logs'

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::LogList
    )
end

#list_mfa_factors ⇒ MfaFactors

List the factors available on the account to be used as a MFA challange.

Returns:

  • (MfaFactors) 


431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/appwrite/services/account.rb', line 431

def list_mfa_factors()
    api_path = '/account/mfa/factors'

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::MfaFactors
    )
end

#list_sessions ⇒ SessionList

Get the list of active sessions across different devices for the currently logged in user.

Returns:

  • (SessionList) 


778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/appwrite/services/account.rb', line 778

def list_sessions()
    api_path = '/account/sessions'

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::SessionList
    )
end

#update_email(email:, password:) ⇒ User

Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request. This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.

Parameters:

  • email (String) —

    User email.

  • password (String) —

    User password. Must be at least 8 chars.

Returns:

  • (User) 


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/appwrite/services/account.rb', line 94

def update_email(email:, password:)
    api_path = '/account/email'

    if email.nil?
      raise Appwrite::Exception.new('Missing required parameter: "email"')
    end

    if password.nil?
      raise Appwrite::Exception.new('Missing required parameter: "password"')
    end

    api_params = {
        email: email,
        password: password,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#update_email_verification(user_id:, secret:) ⇒ Token

Use this endpoint to complete the user email verification process. Use both the userId and secret parameters that were attached to your app URL to verify the user email ownership. If confirmed this route will return a 200 status code.

Parameters:

  • user_id (String) —

    User ID.

  • secret (String) —

    Valid verification token.

Returns:

  • (Token) 


1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/appwrite/services/account.rb', line 1413

def update_email_verification(user_id:, secret:)
    api_path = '/account/verifications/email'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if secret.nil?
      raise Appwrite::Exception.new('Missing required parameter: "secret"')
    end

    api_params = {
        userId: user_id,
        secret: secret,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#update_magic_url_session(user_id:, secret:) ⇒ Session

Deprecated.

This API has been deprecated since 1.6.0. Please use ‘Account.createSession` instead.

Use this endpoint to create a session from token. Provide the userId and secret parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.

Parameters:

  • user_id (String) —

    User ID. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

  • secret (String) —

    Valid verification token.

Returns:

  • (Session) 


899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/appwrite/services/account.rb', line 899

def update_magic_url_session(user_id:, secret:)
    api_path = '/account/sessions/magic-url'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if secret.nil?
      raise Appwrite::Exception.new('Missing required parameter: "secret"')
    end

    api_params = {
        userId: user_id,
        secret: secret,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Session
    )
end

#update_mfa(mfa:) ⇒ User

Enable or disable MFA on an account.

Parameters:

  • [] —

    mfa Enable or disable MFA.

Returns:

  • (User) 


236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/appwrite/services/account.rb', line 236

def update_mfa(mfa:)
    api_path = '/account/mfa'

    if mfa.nil?
      raise Appwrite::Exception.new('Missing required parameter: "mfa"')
    end

    api_params = {
        mfa: mfa,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#update_mfa_authenticator(type:, otp:) ⇒ User

Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method.

Parameters:

  • type (AuthenticatorType) —

    Type of authenticator.

  • otp (String) —

    Valid verification token.

Returns:

  • (User) 


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/appwrite/services/account.rb', line 300

def update_mfa_authenticator(type:, otp:)
    api_path = '/account/mfa/authenticators/{type}'
        .gsub('{type}', type)

    if type.nil?
      raise Appwrite::Exception.new('Missing required parameter: "type"')
    end

    if otp.nil?
      raise Appwrite::Exception.new('Missing required parameter: "otp"')
    end

    api_params = {
        otp: otp,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#update_mfa_challenge(challenge_id:, otp:) ⇒ Session

Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.

Parameters:

  • challenge_id (String) —

    ID of the challenge.

  • otp (String) —

    Valid verification token.

Returns:

  • (Session) 


398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/appwrite/services/account.rb', line 398

def update_mfa_challenge(challenge_id:, otp:)
    api_path = '/account/mfa/challenges'

    if challenge_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "challengeId"')
    end

    if otp.nil?
      raise Appwrite::Exception.new('Missing required parameter: "otp"')
    end

    api_params = {
        challengeId: challenge_id,
        otp: otp,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Session
    )
end

#update_mfa_recovery_codes ⇒ MfaRecoveryCodes

Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.

Returns:

  • (MfaRecoveryCodes) 


508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/appwrite/services/account.rb', line 508

def update_mfa_recovery_codes()
    api_path = '/account/mfa/recovery-codes'

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::MfaRecoveryCodes
    )
end

#update_name(name:) ⇒ User

Update currently logged in user account name.

Parameters:

  • name (String) —

    User name. Max length: 128 chars.

Returns:

  • (User) 


532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/appwrite/services/account.rb', line 532

def update_name(name:)
    api_path = '/account/name'

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        name: name,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#update_password(password:, old_password: nil) ⇒ User

Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.

Parameters:

  • password (String) —

    New user password. Must be at least 8 chars.

  • old_password (String) (defaults to: nil) —

    Current user password. Must be at least 8 chars.

Returns:

  • (User) 


564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/appwrite/services/account.rb', line 564

def update_password(password:, old_password: nil)
    api_path = '/account/password'

    if password.nil?
      raise Appwrite::Exception.new('Missing required parameter: "password"')
    end

    api_params = {
        password: password,
        oldPassword: old_password,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#update_phone(phone:, password:) ⇒ User

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](appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) endpoint to send a confirmation SMS.

Parameters:

  • phone (String) —

    Phone number. Format this number with a leading ‘+’ and a country code, e.g., +16175551212.

  • password (String) —

    User password. Must be at least 8 chars.

Returns:

  • (User) 


599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/appwrite/services/account.rb', line 599

def update_phone(phone:, password:)
    api_path = '/account/phone'

    if phone.nil?
      raise Appwrite::Exception.new('Missing required parameter: "phone"')
    end

    if password.nil?
      raise Appwrite::Exception.new('Missing required parameter: "password"')
    end

    api_params = {
        phone: phone,
        password: password,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#update_phone_session(user_id:, secret:) ⇒ Session

Deprecated.

This API has been deprecated since 1.6.0. Please use ‘Account.createSession` instead.

Use this endpoint to create a session from token. Provide the userId and secret parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.

Parameters:

  • user_id (String) —

    User ID. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

  • secret (String) —

    Valid verification token.

Returns:

  • (Session) 


939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/appwrite/services/account.rb', line 939

def update_phone_session(user_id:, secret:)
    api_path = '/account/sessions/phone'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if secret.nil?
      raise Appwrite::Exception.new('Missing required parameter: "secret"')
    end

    api_params = {
        userId: user_id,
        secret: secret,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Session
    )
end

#update_phone_verification(user_id:, secret:) ⇒ Token

Use this endpoint to complete the user phone verification process. Use the userId and secret that were sent to your user’s phone number to verify the user email ownership. If confirmed this route will return a 200 status code.

Parameters:

  • user_id (String) —

    User ID.

  • secret (String) —

    Valid verification token.

Returns:

  • (Token) 


1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/appwrite/services/account.rb', line 1522

def update_phone_verification(user_id:, secret:)
    api_path = '/account/verifications/phone'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if secret.nil?
      raise Appwrite::Exception.new('Missing required parameter: "secret"')
    end

    api_params = {
        userId: user_id,
        secret: secret,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#update_prefs(prefs:) ⇒ User

Update currently logged in user account preferences. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.

Parameters:

  • prefs (Hash) —

    Prefs key-value JSON object.

Returns:

  • (User) 


657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/appwrite/services/account.rb', line 657

def update_prefs(prefs:)
    api_path = '/account/prefs'

    if prefs.nil?
      raise Appwrite::Exception.new('Missing required parameter: "prefs"')
    end

    api_params = {
        prefs: prefs,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#update_recovery(user_id:, secret:, password:) ⇒ Token

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](appwrite.io/docs/references/cloud/client-web/account#createRecovery) endpoint.

Please note that in order to avoid a [Redirect Attack](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.

Parameters:

  • user_id (String) —

    User ID.

  • secret (String) —

    Valid reset token.

  • password (String) —

    New user password. Must be between 8 and 256 chars.

Returns:

  • (Token) 


739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/appwrite/services/account.rb', line 739

def update_recovery(user_id:, secret:, password:)
    api_path = '/account/recovery'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if secret.nil?
      raise Appwrite::Exception.new('Missing required parameter: "secret"')
    end

    if password.nil?
      raise Appwrite::Exception.new('Missing required parameter: "password"')
    end

    api_params = {
        userId: user_id,
        secret: secret,
        password: password,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end

#update_session(session_id:) ⇒ Session

Use this endpoint to extend a session’s length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.

Parameters:

  • session_id (String) —

    Session ID. Use the string ‘current’ to update the current device session.

Returns:

  • (Session) 


1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/appwrite/services/account.rb', line 1041

def update_session(session_id:)
    api_path = '/account/sessions/{sessionId}'
        .gsub('{sessionId}', session_id)

    if session_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "sessionId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Session
    )
end

#update_status ⇒ User

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.

Returns:

  • (User) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/appwrite/services/account.rb', line 1103

def update_status()
    api_path = '/account/status'

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::User
    )
end

#update_verification(user_id:, secret:) ⇒ Token

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘Account.updateEmailVerification` instead.

Use this endpoint to complete the user email verification process. Use both the userId and secret parameters that were attached to your app URL to verify the user email ownership. If confirmed this route will return a 200 status code.

Parameters:

  • user_id (String) —

    User ID.

  • secret (String) —

    Valid verification token.

Returns:

  • (Token) 


1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/appwrite/services/account.rb', line 1454

def update_verification(user_id:, secret:)
    api_path = '/account/verifications/email'

    if user_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "userId"')
    end

    if secret.nil?
      raise Appwrite::Exception.new('Missing required parameter: "secret"')
    end

    api_params = {
        userId: user_id,
        secret: secret,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Token
    )
end