U ڲgD@sVdZddlZddlmZddlZddlmZddlZddlm Z ddlm Z ddlm Z ddlm Z dd l mZd Zd Zed ZGd d d ZedZGdddZGdddZGdddeZGdddeZGdddZGdddZGdddZGdddZGdd d eZGd!d"d"Zd#d$ZGd%d&d&Z Gd'd(d(e j!Z"dS))z$Firebase user management sub module.N) defaultdict)parse) _auth_utils)_rfc3339)_user_identifier) _user_import ErrorInfosREDACTEDc@seZdZddZdS)SentinelcCs ||_dSN) description)selfr reZdZdZd ddZeddZeddZed d ZdS) UserMetadataz._int_or_noneNZ lastRefreshAtr Z createdAtZ lastLoginAt)r3r2rBrZparse_to_epochr)rrFZlast_refresh_at_millisZlast_refresh_at_rfc3339rrr user_metadatas zUserRecord.user_metadatacCs|jdg}dd|DS)zReturns a list of UserInfo instances. Each object represents an identity from an identity provider that is linked to this user. Returns: list: A list of UserInfo objects, which may be empty. ZproviderUserInfocSsg|] }t|qSr)ProviderUserInfo).0entryrrr sz,UserRecord.provider_data..r8)rZ providersrrr provider_datas zUserRecord.provider_datacCs*|jd}|r&t|}|ikr&|SdS)z~Returns any custom claims set on this user account. Returns: dict: A dictionary of claims or None. customAttributesN)r3r2jsonloads)rZclaimsparsedrrr custom_claimss   zUserRecord.custom_claimscCs |jdS)zlReturns the tenant ID of this user. Returns: string: A tenant ID string or None. ZtenantIdr8rrrr tenant_id szUserRecord.tenant_id)rrrrrrr#r$r%r&r'r(r?r@rDrGrLrQrR __classcell__rrr6rr)s8             r)c@s(eZdZdZeddZeddZdS)ExportedUserRecordzJContains metadata associated with a user including password hash and salt.cCs|jd}|tkrdS|S)aThe user's password hash as a base64-encoded string. If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account, this is the base64-encoded password hash of the user. If a different hashing algorithm was used to create this user, as is typical when migrating from another Auth system, this is an empty string. If no password is set, or if the service account doesn't have permission to read the password, then this is ``None``. passwordHashN)r3r2 B64_REDACTED)r password_hashrrrrWs z ExportedUserRecord.password_hashcCs |jdS)aThe user's password salt as a base64-encoded string. If the Firebase Auth hashing algorithm (SCRYPT) was used to create the user account, this is the base64-encoded password salt of the user. If a different hashing algorithm was used to create this user, as is typical when migrating from another Auth system, this is an empty string. If no password is set, or if the service account doesn't have permission to read the password, then this is ``None``. Zsaltr8rrrr password_salt-s z ExportedUserRecord.password_saltN)rrrrrrWrXrrrrrTs  rTc@s0eZdZdZddZeddZeddZdS) GetUsersResultz6Represents the result of the ``auth.get_users()`` API.cCs||_||_dS)zConstructs a `GetUsersResult` object. Args: users: List of `UserRecord` instances. not_found: List of `UserIdentifier` instances. N)_users _not_found)rusers not_foundrrrr=szGetUsersResult.__init__cCs|jS)zSet of `UserRecord` instances, corresponding to the set of users that were requested. Only users that were found are listed here. The result set is unordered. )rZrrrrr\GszGetUsersResult.userscCs|jS)zVSet of `UserIdentifier` instances that were requested, but not found. )r[rrrrr]OszGetUsersResult.not_foundN)rrrrrrr\r]rrrrrY:s   rYc@sLeZdZdZddZeddZeddZedd Zd d Z d d Z dS) ListUsersPageaTRepresents a page of user records exported from a Firebase project. Provides methods for traversing the user accounts included in this page, as well as retrieving subsequent pages of users. The iterator returned by ``iterate_all()`` can be used to iterate through all users in the Firebase project starting from this page. cCs||_||_||||_dSr ) _download _max_results_current)rdownload page_token max_resultsrrrr_szListUsersPage.__init__cCsdd|jdgDS)zBA list of ``ExportedUserRecord`` instances available in this page.cSsg|] }t|qSr)rT)rIuserrrrrKgsz'ListUsersPage.users..r\rar2rrrrr\dszListUsersPage.userscCs|jddS)zKPage token string for the next page (empty string indicates no more pages). nextPageTokenrfrrrrnext_page_tokeniszListUsersPage.next_page_tokencCs t|jS)z6A boolean indicating whether more pages are available.)r>rirrrr has_next_pagenszListUsersPage.has_next_pagecCs|jrt|j|j|jSdS)zRetrieves the next page of user accounts, if available. Returns: ListUsersPage: Next page of users, or None if this is the last page. N)rjr^r_rir`rrrr get_next_pagesszListUsersPage.get_next_pagecCst|S)a]Retrieves an iterator for user accounts. Returned iterator will iterate through all the user accounts in the Firebase project starting from this page. The iterator will never buffer more than one page of users in memory at a time. Returns: iterator: An iterator of ExportedUserRecord instances. ) _UserIteratorrrrr iterate_all}s zListUsersPage.iterate_allN) rrrrrrr\rirjrkrmrrrrr^Ws    r^c@s<eZdZdZddZeddZeddZedd Zd S) DeleteUsersResultz9Represents the result of the ``auth.delete_users()`` API.cCs(|j}|t||_t||_||_dS)zConstructs a `DeleteUsersResult` object. Args: result: The proto response, wrapped in a `BatchDeleteAccountsResponse` instance. total: Total integer number of deletion attempts. N)errorslen_success_count_failure_count_errors)rresulttotalrorrrrs zDeleteUsersResult.__init__cCs|jS)zReturns the number of users that were deleted successfully (possibly zero). Users that did not exist prior to calling `delete_users()` are considered to be successfully deleted. )rqrrrr success_countszDeleteUsersResult.success_countcCs|jS)zWReturns the number of users that failed to be deleted (possibly zero). )rrrrrr failure_countszDeleteUsersResult.failure_countcCs|jS)zA list of `auth.ErrorInfo` instances describing the errors that were encountered during the deletion. Length of this list is equal to `failure_count`. )rsrrrrroszDeleteUsersResult.errorsN) rrrrrrrvrwrorrrrrns   rnc@seZdZdZdddZdS)BatchDeleteAccountsResponsez2Represents the results of a `delete_users()` call.NcCs|rdd|Dng|_dS)aaConstructs a `BatchDeleteAccountsResponse` instance, corresponding to the JSON representing the `BatchDeleteAccountsResponse` proto. Args: errors: List of dictionaries, with each dictionary representing an `ErrorInfo` instance as returned by the server. `None` implies an empty list. cSsg|] }t|qSrr)rIerrrrrrKsz8BatchDeleteAccountsResponse.__init__..N)ro)rrorrrrs z$BatchDeleteAccountsResponse.__init__)NrrrrrrrrrrxsrxcsheZdZdZfddZeddZeddZedd Zed d Z ed d Z eddZ Z S)rHzRContains metadata regarding how a user is known by a particular identity provider.csBtt|t|ts&td||ds8td||_dS)Nr*rawIdr,) r-rHrr.r/r0r1r2r3r4r6rrrs   zProviderUserInfo.__init__cCs |jdS)Nr{r8rrrrr#szProviderUserInfo.uidcCs |jdS)Nr9r8rrrrr$szProviderUserInfo.display_namecCs |jdS)Nr%r8rrrrr%szProviderUserInfo.emailcCs |jdS)Nr:r8rrrrr&szProviderUserInfo.phone_numbercCs |jdS)Nr;r8rrrrr'szProviderUserInfo.photo_urlcCs |jdS)N providerIdr8rrrrr(szProviderUserInfo.provider_id) rrrrrrr#r$r%r&r'r(rSrrr6rrHs      rHc@seZdZdZdddZdS)ActionCodeSettingszContains required continue/state URL with optional Android and iOS settings. Used when invoking the email action link generation APIs. NcCs.||_||_||_||_||_||_||_dSr )urlhandle_code_in_appdynamic_link_domain ios_bundle_idandroid_package_nameandroid_install_appandroid_minimum_version)rr~rrrrrrrrrrszActionCodeSettings.__init__)NNNNNNrzrrrrr}s r}cCsi}|jstdz0t|j}|js6td|j|j|d<Wn$tk rftd|jYnX|jdk rt|jt std|j|j|d<|j dk rt|j t std|j |j |d<|j dk rt|j t std |j |j |d <|j s|jr|jstd |jdk rLt|jt sBtd |j|j|d <|j dk rt|j t svtd|j |j |d<|jdk rt|jt std|j|j|d<|S)z Validates the provided action code settings for email link generation and populates the REST api parameters. settings - ``ActionCodeSettings`` object provided to be encoded returns - dict of parameters to be passed for link gereration. z%Dynamic action links url is mandatoryz*Malformed dynamic action links url: "{0}".Z continueUrlNz2Invalid value provided for handle_code_in_app: {0}ZcanHandleCodeInAppz3Invalid value provided for dynamic_link_domain: {0}ZdynamicLinkDomainz-Invalid value provided for ios_bundle_id: {0}Z iOSBundleIdzGAndroid package name is required when specifying other Android settingsz4Invalid value provided for android_package_name: {0}ZandroidPackageNamez7Invalid value provided for android_minimum_version: {0}ZandroidMinimumVersionz3Invalid value provided for android_install_app: {0}ZandroidInstallApp)r~r0rurlparsenetlocr1 Exceptionrr.r>rstrrrrr)settings parametersrPrrrencode_action_code_settingssf                rc @s~eZdZdZdZdddZddZdd Zdefd d Z dd d Z dddZ ddZ dddZ dddZd ddZddZdS)! UserManagerzBProvides methods for interacting with the Google Identity Toolkit.z)https://identitytoolkit.googleapis.com/v1NcCs:||_|p|j}d|||_|r6|jd|7_dS)Nz{0}/projects/{1}z /tenants/{0}) http_clientID_TOOLKIT_URLr1base_url)rrZ project_idrRZ url_overrideZ url_prefixrrrr@s  zUserManager.__init__cKsd|kr.|dd}}dtj|ddgi}njd|kr\|dd}}dtj|ddgi}nsz+UserManager.create_user..rz /accountsrr+zFailed to create new user.r) rrvalidate_display_namerrvalidate_photo_urlvalidate_passwordr>itemsrr2r) rr#r$r%r&r'rr@r?rrrrrr create_users" zUserManager.create_userc Cstj|ddt|t|t| d|dk r6t|nd|dk rHt|ndd} g} t| }|dk r|tkrz| dnt || d<|dk r|tkr| dnt || d <| r| | d <|dk r|tkr|d nt || d <| dk r&| tkri} t | t rt| n| }t|| d <|rUpdates an existing user account with the specified propertiesTrrCN)r+r%rrAr<Z disableUserZ DISPLAY_NAMEr9Z PHOTO_URLr;ZdeleteAttributeZphoner:rMZdeleteProvidercSsi|]\}}|dk r||qSr rrrrrrsz+UserManager.update_user..rz/accounts:updaterr+zFailed to update user: {0}.r)rrrrrr>Zvalidate_provider_idsDELETE_ATTRIBUTErrrrr.r/rNdumpsZvalidate_custom_claimsrsetrrr2rr1)rr#r$r%r&r'rr@r?rCrQZproviders_to_deleterremoveZremove_providerZ json_claimsrrrrr update_usersV        zUserManager.update_usercCsLtj|dd|jddd|id\}}|r4|dsHtjd||d d S) z5Deletes the user identified by the specified user ID.Trrz/accounts:deleter+rkindzFailed to delete user: {0}.rN)rrrr2rr1)rr#rrrrr delete_userszUserManager.delete_userFcCsx|s tSt|dkrtd|D]}tj|ddq"|jdd||dd\}}t|tshtjd |d t| d gS) aDeletes the users identified by the specified user ids. Args: uids: A list of strings indicating the uids of the users to be deleted. Must have <= 1000 entries. force_delete: Optional parameter that indicates if users should be deleted, even if they're not disabled. Defaults to False. Returns: BatchDeleteAccountsResponse: Server's proto response, wrapped in a python object. Raises: ValueError: If any of the identifiers are invalid or if more than 1000 identifiers are specified. UnexpectedResponseError: If the backend server responds with an unexpected message. r z*`uids` paramter must have <= 1000 entries.Trrz/accounts:batchDelete)ZlocalIdsforcerzAUnexpected response from server while attempting to delete users.rro) rxrpr0rrrr.r/rr2)rZuidsZ force_deleter#rrrrr delete_userss   zUserManager.delete_userscCsz<|rt|tkr tdttdd|Dr:tdWntk rXtdYnXddd|Di}tdd|dDrt|tjstd | | |j d d |d \}}t|t st jd |d|S)z1Imports the given list of users to Firebase Auth.z>Users must be a non-empty list with no more than {0} elements.cSsg|]}t|tj qSr)r.rZImportUserRecordrIurrrrKsz,UserManager.import_users..z%One or more user objects are invalid.zusers must be iterabler\cSsg|] }|qSr)to_dictrrrrrKscSsg|] }d|kqS)rUrrrrrrKszs>        ))#3*$D