@@ -265,18 +265,18 @@ def update_user(uid, **kwargs):
265
265
def set_custom_user_claims (uid , custom_claims , app = None ):
266
266
"""Sets additional claims on an existing user account.
267
267
268
- Custom claims set via this function can be used to define user roles and privilege levels.
269
- These claims propagate to all the devices where the user is already signed in (after token
270
- expiration or when token refresh is forced), and next time the user signs in. The claims
271
- can be accessed via the user's ID token JWT. If a reserved OIDC claim is specified (sub, iat,
272
- iss, etc), an error is thrown. Claims payload must also not be larger then 1000 characters
273
- when serialized into a JSON string.
274
-
275
- Args:
276
- uid: A user ID string.
277
- custom_claims: A dictionary or a JSON string of custom claims. Pass None to unset any
278
- claims set previously.
279
- app: An App instance (optional).
268
+ Custom claims set via this function can be used to define user roles and privilege levels.
269
+ These claims propagate to all the devices where the user is already signed in (after token
270
+ expiration or when token refresh is forced), and next time the user signs in. The claims
271
+ can be accessed via the user's ID token JWT. If a reserved OIDC claim is specified (sub, iat,
272
+ iss, etc), an error is thrown. Claims payload must also not be larger then 1000 characters
273
+ when serialized into a JSON string.
274
+
275
+ Args:
276
+ uid: A user ID string.
277
+ custom_claims: A dictionary or a JSON string of custom claims. Pass None to unset any
278
+ claims set previously.
279
+ app: An App instance (optional).
280
280
281
281
Raises:
282
282
ValueError: If the specified user ID or the custom claims are invalid.
@@ -497,9 +497,9 @@ def password_hash(self):
497
497
"""The user's password hash as a base64-encoded string.
498
498
499
499
If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account, this
500
- will be the base64-encoded password hash of the user. If a different hashing algorithm was
500
+ is the base64-encoded password hash of the user. If a different hashing algorithm was
501
501
used to create this user, as is typical when migrating from another Auth system, this
502
- will be an empty string. If no password is set, this will be None.
502
+ is an empty string. If no password is set, this is `` None`` .
503
503
"""
504
504
return self ._data .get ('passwordHash' )
505
505
@@ -508,9 +508,9 @@ def password_salt(self):
508
508
"""The user's password salt as a base64-encoded string.
509
509
510
510
If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account, this
511
- will be the base64-encoded password salt of the user. If a different hashing algorithm was
512
- used to create this user, as is typical when migrating from another Auth system, this will
513
- be an empty string. If no password is set, this will be None.
511
+ is the base64-encoded password salt of the user. If a different hashing algorithm was
512
+ used to create this user, as is typical when migrating from another Auth system, this is
513
+ an empty string. If no password is set, this is `` None`` .
514
514
"""
515
515
return self ._data .get ('salt' )
516
516
0 commit comments