You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/identitytoolkit_v1.accounts.html
+3-2Lines changed: 3 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -258,7 +258,7 @@ <h3>Method Details</h3>
258
258
"email": [ # The email address of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `[email protected]`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer.
259
259
"A String",
260
260
],
261
-
"federatedUserId": [ # The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).
261
+
"federatedUserId": [
262
262
{ # Federated user identifier at an Identity Provider.
263
263
"providerId": "A String", # The ID of supported identity providers. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`.
264
264
"rawId": "A String", # The user ID of the account at the third-party Identity Provider specified by `provider_id`.
@@ -412,6 +412,7 @@ <h3>Method Details</h3>
412
412
"iOSAppStoreId": "A String", # If an associated iOS app can handle the OOB code, the App Store id of this app. This will allow App Store to open to the correct app if the app is not yet installed.
413
413
"iOSBundleId": "A String", # If an associated iOS app can handle the OOB code, the iOS bundle id of this app. This will allow the correct app to open if it is already installed.
414
414
"idToken": "A String", # An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true.
415
+
"linkDomain": "A String", # Optional. In order to ensure that the url used can be easily opened in iOS or Android, we create a Hosting link '/__/auth/links'. This optional field contains the domain to use when constructing a Hosting link. If not set, '.firebaseapp.com' domain will be used.
415
416
"newEmail": "A String", # The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests.
416
417
"recaptchaVersion": "A String", # The reCAPTCHA version of the reCAPTCHA token in the captcha_response.
417
418
"requestType": "A String", # Required. The type of out-of-band (OOB) code to send. Depending on this value, other fields in this request will be required and/or have different meanings. There are 4 different OOB codes that can be sent: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
@@ -862,7 +863,7 @@ <h3>Method Details</h3>
862
863
"createdAt": "A String", # The timestamp in milliseconds when the account was created.
863
864
"customAttributes": "A String", # JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).
Copy file name to clipboardExpand all lines: docs/dyn/identitytoolkit_v1.projects.accounts.html
+7-6Lines changed: 7 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -132,7 +132,7 @@ <h3>Method Details</h3>
132
132
"hashAlgorithm": "A String", # Required. The hashing function used to hash the account passwords. Must be one of the following: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2
133
133
"memoryCost": 42, # Memory cost for hash calculation. Only required when the hashing function is SCRYPT.
134
134
"parallelization": 42, # The parallelization cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance.
135
-
"passwordHashOrder": "A String", # Password and salt order when verify password.
"rounds": 42, # The number of rounds used for hash calculation. Only required for the following hashing functions: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT
137
137
"saltSeparator": "A String", # One or more bytes to be inserted between the salt and plain text password. For stronger security, this should be a single non-printable character.
138
138
"sanityCheck": True or False, # If true, the service will do the following list of checks before an account is uploaded: * Duplicate emails * Duplicate federated IDs * Federated ID provider validation If the duplication exists within the list of accounts to be uploaded, it will prevent the entire list from being uploaded. If the email or federated ID is a duplicate of a user already within the project/tenant, the account will not be uploaded, but the rest of the accounts will be unaffected. If false, these checks will be skipped.
@@ -392,7 +392,7 @@ <h3>Method Details</h3>
392
392
"email": [ # The email address of one or more accounts to fetch. The length of email should be less than 256 characters and in the format of `[email protected]`. The email should also match the [RFC 822](https://tools.ietf.org/html/rfc822) addr-spec production. Should only be specified by authenticated requests from a developer.
393
393
"A String",
394
394
],
395
-
"federatedUserId": [ # The federated user identifier of one or more accounts to fetch. Should only be specified by authenticated requests bearing a Google OAuth 2.0 credential with proper [permissions](https://cloud.google.com/identity-platform/docs/access-control).
395
+
"federatedUserId": [
396
396
{ # Federated user identifier at an Identity Provider.
397
397
"providerId": "A String", # The ID of supported identity providers. This should be a provider ID enabled for sign-in, which is either from the list of [default supported IdPs](https://cloud.google.com/identity-platform/docs/reference/rest/v2/defaultSupportedIdps/list), or of the format `oidc.*` or `saml.*`. Some examples are `google.com`, `facebook.com`, `oidc.testapp`, and `saml.testapp`.
398
398
"rawId": "A String", # The user ID of the account at the third-party Identity Provider specified by `provider_id`.
@@ -490,7 +490,7 @@ <h3>Method Details</h3>
490
490
The object takes the form of:
491
491
492
492
{ # Request message for QueryUserInfo.
493
-
"expression": [ # Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated.
493
+
"expression": [
494
494
{ # Query conditions used to filter results.
495
495
"email": "A String", # A case insensitive string that the account's email should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied.
496
496
"phoneNumber": "A String", # A string that the account's phone number should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied.
@@ -499,9 +499,9 @@ <h3>Method Details</h3>
499
499
],
500
500
"limit": "A String", # The maximum number of accounts to return with an upper limit of __500__. Defaults to _500_. Only valid when `return_user_info` is set to `true`.
501
501
"offset": "A String", # The number of accounts to skip from the beginning of matching records. Only valid when `return_user_info` is set to `true`.
502
-
"order": "A String", # The order for sorting query result. Defaults to __ascending__ order. Only valid when `return_user_info` is set to `true`.
502
+
"order": "A String",
503
503
"returnUserInfo": True or False, # If `true`, this request will return the accounts matching the query. If `false`, only the __count__ of accounts matching the query will be returned. Defaults to `true`.
504
-
"sortBy": "A String", # The field to use for sorting user accounts. Defaults to `USER_ID`. Note: when `phone_number` is specified in `expression`, the result ignores the sorting. Only valid when `return_user_info` is set to `true`.
504
+
"sortBy": "A String",
505
505
"tenantId": "A String", # The ID of the tenant to which the result is scoped.
506
506
}
507
507
@@ -596,6 +596,7 @@ <h3>Method Details</h3>
596
596
"iOSAppStoreId": "A String", # If an associated iOS app can handle the OOB code, the App Store id of this app. This will allow App Store to open to the correct app if the app is not yet installed.
597
597
"iOSBundleId": "A String", # If an associated iOS app can handle the OOB code, the iOS bundle id of this app. This will allow the correct app to open if it is already installed.
598
598
"idToken": "A String", # An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true.
599
+
"linkDomain": "A String", # Optional. In order to ensure that the url used can be easily opened in iOS or Android, we create a Hosting link '/__/auth/links'. This optional field contains the domain to use when constructing a Hosting link. If not set, '.firebaseapp.com' domain will be used.
599
600
"newEmail": "A String", # The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests.
600
601
"recaptchaVersion": "A String", # The reCAPTCHA version of the reCAPTCHA token in the captcha_response.
601
602
"requestType": "A String", # Required. The type of out-of-band (OOB) code to send. Depending on this value, other fields in this request will be required and/or have different meanings. There are 4 different OOB codes that can be sent: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
@@ -636,7 +637,7 @@ <h3>Method Details</h3>
636
637
"createdAt": "A String", # The timestamp in milliseconds when the account was created.
637
638
"customAttributes": "A String", # JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper [permissions] (https://cloud.google.com/identity-platform/docs/access-control).
Copy file name to clipboardExpand all lines: docs/dyn/identitytoolkit_v1.projects.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -137,7 +137,7 @@ <h3>Method Details</h3>
137
137
The object takes the form of:
138
138
139
139
{ # Request message for QueryUserInfo.
140
-
"expression": [ # Query conditions used to filter results. If more than one is passed, only the first SqlExpression is evaluated.
140
+
"expression": [
141
141
{ # Query conditions used to filter results.
142
142
"email": "A String", # A case insensitive string that the account's email should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied.
143
143
"phoneNumber": "A String", # A string that the account's phone number should match. Only one of `email`, `phone_number`, or `user_id` should be specified in a SqlExpression. If more than one is specified, only the first (in that order) will be applied.
@@ -146,9 +146,9 @@ <h3>Method Details</h3>
146
146
],
147
147
"limit": "A String", # The maximum number of accounts to return with an upper limit of __500__. Defaults to _500_. Only valid when `return_user_info` is set to `true`.
148
148
"offset": "A String", # The number of accounts to skip from the beginning of matching records. Only valid when `return_user_info` is set to `true`.
149
-
"order": "A String", # The order for sorting query result. Defaults to __ascending__ order. Only valid when `return_user_info` is set to `true`.
149
+
"order": "A String",
150
150
"returnUserInfo": True or False, # If `true`, this request will return the accounts matching the query. If `false`, only the __count__ of accounts matching the query will be returned. Defaults to `true`.
151
-
"sortBy": "A String", # The field to use for sorting user accounts. Defaults to `USER_ID`. Note: when `phone_number` is specified in `expression`, the result ignores the sorting. Only valid when `return_user_info` is set to `true`.
151
+
"sortBy": "A String",
152
152
"tenantId": "A String", # The ID of the tenant to which the result is scoped.
0 commit comments