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) 


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
80
 
# File 'lib/appwrite/services/account.rb', line 47

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) 


851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/appwrite/services/account.rb', line 851

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) 


882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
 
# File 'lib/appwrite/services/account.rb', line 882

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

  • 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) 


1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'lib/appwrite/services/account.rb', line 1163

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_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) 


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

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.

  • 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) 


1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/appwrite/services/account.rb', line 1215

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) 


272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/appwrite/services/account.rb', line 272

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) 


371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/appwrite/services/account.rb', line 371

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

    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) 


493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/appwrite/services/account.rb', line 493

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:



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
 
# File 'lib/appwrite/services/account.rb', line 1268

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.

  • phone (String) —

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

Returns:

  • (Token) 


1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/appwrite/services/account.rb', line 1310

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) 


1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
 
# File 'lib/appwrite/services/account.rb', line 1434

def create_phone_verification()
    api_path = '/account/verification/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) 


712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
 
# File 'lib/appwrite/services/account.rb', line 712

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) 


996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/appwrite/services/account.rb', line 996

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

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) 


1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
 
# File 'lib/appwrite/services/account.rb', line 1359

def create_verification(url:)
    api_path = '/account/verification'

    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:



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

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:



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/appwrite/services/account.rb', line 340

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:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/appwrite/services/account.rb', line 1097

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:



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/appwrite/services/account.rb', line 822

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) 


466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/appwrite/services/account.rb', line 466

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) 


648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/appwrite/services/account.rb', line 648

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) 


1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'lib/appwrite/services/account.rb', line 1032

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) ⇒ 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

Returns:

  • (IdentityList) 


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

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

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

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

#list_logs(queries: 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

Returns:

  • (LogList) 


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

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

    api_params = {
        queries: queries,
    }
    
    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) 


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/appwrite/services/account.rb', line 440

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) 


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

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) 


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
122
123
 
# File 'lib/appwrite/services/account.rb', line 96

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_magic_url_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) —

    Valid verification token.

Returns:

  • (Session) 


920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/appwrite/services/account.rb', line 920

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) 


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

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) 


305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/appwrite/services/account.rb', line 305

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) 


406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/appwrite/services/account.rb', line 406

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

    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) 


520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/appwrite/services/account.rb', line 520

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) 


545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/appwrite/services/account.rb', line 545

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) 


578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/appwrite/services/account.rb', line 578

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) 


614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/appwrite/services/account.rb', line 614

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

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) 


958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
 
# File 'lib/appwrite/services/account.rb', line 958

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) 


1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'lib/appwrite/services/account.rb', line 1463

def update_phone_verification(user_id:, secret:)
    api_path = '/account/verification/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) 


674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/appwrite/services/account.rb', line 674

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) 


758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/appwrite/services/account.rb', line 758

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) 


1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'lib/appwrite/services/account.rb', line 1063

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) 


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/appwrite/services/account.rb', line 1127

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

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) 


1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/appwrite/services/account.rb', line 1393

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

    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