1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
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
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
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
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
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
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="identitytoolkit_v2.html">Identity Toolkit API</a> . <a href="identitytoolkit_v2.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="identitytoolkit_v2.projects.defaultSupportedIdpConfigs.html">defaultSupportedIdpConfigs()</a></code>
</p>
<p class="firstline">Returns the defaultSupportedIdpConfigs Resource.</p>
<p class="toc_element">
<code><a href="identitytoolkit_v2.projects.identityPlatform.html">identityPlatform()</a></code>
</p>
<p class="firstline">Returns the identityPlatform Resource.</p>
<p class="toc_element">
<code><a href="identitytoolkit_v2.projects.inboundSamlConfigs.html">inboundSamlConfigs()</a></code>
</p>
<p class="firstline">Returns the inboundSamlConfigs Resource.</p>
<p class="toc_element">
<code><a href="identitytoolkit_v2.projects.oauthIdpConfigs.html">oauthIdpConfigs()</a></code>
</p>
<p class="firstline">Returns the oauthIdpConfigs Resource.</p>
<p class="toc_element">
<code><a href="identitytoolkit_v2.projects.tenants.html">tenants()</a></code>
</p>
<p class="firstline">Returns the tenants Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve an Identity Toolkit project configuration.</p>
<p class="toc_element">
<code><a href="#updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update an Identity Toolkit project configuration.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
<pre>Retrieve an Identity Toolkit project configuration.
Args:
name: string, The resource name of the config, for example: "projects/my-awesome-project/config" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Identity Toolkit project.
"authorizedDomains": [ # List of domains authorized for OAuth redirects
"A String",
],
"autodeleteAnonymousUsers": True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
"blockingFunctions": { # Configuration related to Blocking Functions. # Configuration related to blocking functions.
"forwardInboundCredentials": { # Indicates which credentials to pass to the registered Blocking Functions. # The user credentials to include in the JWT payload that is sent to the registered Blocking Functions.
"accessToken": True or False, # Whether to pass the user's OAuth identity provider's access token.
"idToken": True or False, # Whether to pass the user's OIDC identity provider's ID token.
"refreshToken": True or False, # Whether to pass the user's OAuth identity provider's refresh token.
},
"triggers": { # Map of Trigger to event type. Key should be one of the supported event types: "beforeCreate", "beforeSignIn"
"a_key": { # Synchronous Cloud Function with HTTP Trigger
"functionUri": "A String", # HTTP URI trigger for the Cloud Function.
"updateTime": "A String", # When the trigger was changed.
},
},
},
"client": { # Options related to how clients making requests on behalf of a project should be configured. # Options related to how clients making requests on behalf of a project should be configured.
"apiKey": "A String", # Output only. API key that can be used when making requests for this project.
"firebaseSubdomain": "A String", # Output only. Firebase subdomain.
"permissions": { # Configuration related to restricting a user's ability to affect their account. # Configuration related to restricting a user's ability to affect their account.
"disabledUserDeletion": True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
"disabledUserSignup": True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
},
},
"defaultHostingSite": "A String", # Output only. Default Firebase hosting site name
"emailPrivacyConfig": { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
"enableImprovedEmailPrivacy": True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user's email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
},
"mfa": { # Options related to MultiFactor Authentication for the project. # Configuration for this project's multi-factor authentication, including whether it is active and what factors can be used for the second factor
"enabledProviders": [ # A list of usable second factors for this project.
"A String",
],
"providerConfigs": [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the 'enabled_providers' field.
{ # ProviderConfig describes the supported MFA providers along with their configurations.
"state": "A String", # Describes the state of the MultiFactor Authentication type.
"totpProviderConfig": { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
"adjacentIntervals": 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
},
},
],
"state": "A String", # Whether MultiFactor Authentication has been enabled for this project.
},
"mobileLinksConfig": { # Configuration mobile links. # Configuration for settings related to univeral links (iOS) and app links (Android).
"domain": "A String", # Open code in app domain to use for app links and universal links.
},
"monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
"requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
"enabled": True or False, # Whether logging is enabled for this project or not.
},
},
"multiTenant": { # Configuration related to multi-tenant functionality. # Configuration related to multi-tenant functionality.
"allowTenants": True or False, # Whether this project can have tenants or not.
"defaultTenantLocation": "A String", # The default cloud parent org or folder that the tenant project should be created under. The parent resource name should be in the format of "/", such as "folders/123" or "organizations/456". If the value is not set, the tenant will be created under the same organization or folder as the agent project.
},
"name": "A String", # Output only. The name of the Config resource. Example: "projects/my-awesome-project/config"
"notification": { # Configuration related to sending notifications to users. # Configuration related to sending notifications to users.
"defaultLocale": "A String", # Default locale used for email and SMS in IETF BCP 47 format.
"sendEmail": { # Options for email sending. # Options for email sending.
"callbackUri": "A String", # action url in email template.
"changeEmailTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for change email
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"dnsInfo": { # Information of custom domain DNS verification. By default, default_domain will be used. A custom domain can be configured using VerifyCustomDomain. # Information of custom domain DNS verification.
"customDomain": "A String", # Output only. The applied verified custom domain.
"customDomainState": "A String", # Output only. The current verification state of the custom domain. The custom domain will only be used once the domain verification is successful.
"domainVerificationRequestTime": "A String", # Output only. The timestamp of initial request for the current domain verification.
"pendingCustomDomain": "A String", # Output only. The custom domain that's to be verified.
"useCustomDomain": True or False, # Whether to use custom domain.
},
"legacyResetPasswordTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Reset password email template for legacy Firebase V1 app.
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"method": "A String", # The method used for sending an email.
"resetPasswordTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for reset password
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"revertSecondFactorAdditionTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for reverting second factor addition emails
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"smtp": { # Configuration for SMTP relay # Use a custom SMTP relay
"host": "A String", # SMTP relay host
"password": "A String", # SMTP relay password
"port": 42, # SMTP relay port
"securityMode": "A String", # SMTP security mode.
"senderEmail": "A String", # Sender email for the SMTP relay
"username": "A String", # SMTP relay username
},
"verifyEmailTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for verify email
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
},
"sendSms": { # Options for SMS sending. # Options for SMS sending.
"smsTemplate": { # The template to use when sending an SMS. # Output only. The template to use when sending an SMS.
"content": "A String", # Output only. The SMS's content. Can contain the following placeholders which will be replaced with the appropriate values: %APP_NAME% - For Android or iOS apps, the app's display name. For web apps, the domain hosting the application. %LOGIN_CODE% - The OOB code being sent in the SMS.
},
"useDeviceLocale": True or False, # Whether to use the accept_language header for SMS.
},
},
"passwordPolicyConfig": { # The configuration for the password policy on the project. # The project level password policy configuration.
"forceUpgradeOnSignin": True or False, # Users must have a password compliant with the password policy to sign-in.
"lastUpdateTime": "A String", # Output only. The last time the password policy on the project was updated.
"passwordPolicyEnforcementState": "A String", # Which enforcement mode to use for the password policy.
"passwordPolicyVersions": [ # Must be of length 1. Contains the strength attributes for the password policy.
{ # The strength attributes for the password policy on the project.
"customStrengthOptions": { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
"containsLowercaseCharacter": True or False, # The password must contain a lower case character.
"containsNonAlphanumericCharacter": True or False, # The password must contain a non alpha numeric character.
"containsNumericCharacter": True or False, # The password must contain a number.
"containsUppercaseCharacter": True or False, # The password must contain an upper case character.
"maxPasswordLength": 42, # Maximum password length. No default max length
"minPasswordLength": 42, # Minimum password length. Range from 6 to 30
},
"schemaVersion": 42, # Output only. schema version number for the password policy
},
],
},
"quota": { # Configuration related to quotas. # Configuration related to quotas.
"signUpQuotaConfig": { # Temporary quota increase / decrease # Quota for the Signup endpoint, if overwritten. Signup quota is measured in sign ups per project per hour per IP.
"quota": "A String", # Corresponds to the 'refill_token_count' field in QuotaServer config
"quotaDuration": "A String", # How long this quota will be active for
"startTime": "A String", # When this quota will take effect
},
},
"recaptchaConfig": { # The reCAPTCHA Enterprise integration config. # The project-level reCAPTCHA config.
"emailPasswordEnforcementState": "A String", # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
"managedRules": [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
{ # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
"action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
},
],
"phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
"recaptchaKeys": [ # The reCAPTCHA keys.
{ # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
"key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}"
"type": "A String", # The client's platform type.
},
],
"tollFraudManagedRules": [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
{ # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
"action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
"startScore": 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
},
],
"useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
"useSmsBotScore": True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
"useSmsTollFraudProtection": True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
},
"signIn": { # Configuration related to local sign in methods. # Configuration related to local sign in methods.
"allowDuplicateEmails": True or False, # Whether to allow more than one account to have the same email.
"anonymous": { # Configuration options related to authenticating an anonymous user. # Configuration options related to authenticating an anonymous user.
"enabled": True or False, # Whether anonymous user auth is enabled for the project or not.
},
"email": { # Configuration options related to authenticating a user by their email address. # Configuration options related to authenticating a user by their email address.
"enabled": True or False, # Whether email auth is enabled for the project or not.
"passwordRequired": True or False, # Whether a password is required for email auth or not. If true, both an email and password must be provided to sign in. If false, a user may sign in via either email/password or email link.
},
"hashConfig": { # History information of the hash algorithm and key. Different accounts' passwords may be generated by different version. # Output only. Hash config information.
"algorithm": "A String", # Output only. Different password hash algorithms used in Identity Toolkit.
"memoryCost": 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
"rounds": 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
"saltSeparator": "A String", # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
"signerKey": "A String", # Output only. Signer key in base64.
},
"phoneNumber": { # Configuration options related to authenticated a user by their phone number. # Configuration options related to authenticated a user by their phone number.
"enabled": True or False, # Whether phone number auth is enabled for the project or not.
"testPhoneNumbers": { # A map of that can be used for phone auth testing.
"a_key": "A String",
},
},
},
"smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
"allowByDefault": { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
"disallowedRegions": [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
"A String",
],
},
"allowlistOnly": { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
"allowedRegions": [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
"A String",
],
},
},
"subtype": "A String", # Output only. The subtype of this config.
}</pre>
</div>
<div class="method">
<code class="details" id="updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update an Identity Toolkit project configuration.
Args:
name: string, Output only. The name of the Config resource. Example: "projects/my-awesome-project/config" (required)
body: object, The request body.
The object takes the form of:
{ # Represents an Identity Toolkit project.
"authorizedDomains": [ # List of domains authorized for OAuth redirects
"A String",
],
"autodeleteAnonymousUsers": True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
"blockingFunctions": { # Configuration related to Blocking Functions. # Configuration related to blocking functions.
"forwardInboundCredentials": { # Indicates which credentials to pass to the registered Blocking Functions. # The user credentials to include in the JWT payload that is sent to the registered Blocking Functions.
"accessToken": True or False, # Whether to pass the user's OAuth identity provider's access token.
"idToken": True or False, # Whether to pass the user's OIDC identity provider's ID token.
"refreshToken": True or False, # Whether to pass the user's OAuth identity provider's refresh token.
},
"triggers": { # Map of Trigger to event type. Key should be one of the supported event types: "beforeCreate", "beforeSignIn"
"a_key": { # Synchronous Cloud Function with HTTP Trigger
"functionUri": "A String", # HTTP URI trigger for the Cloud Function.
"updateTime": "A String", # When the trigger was changed.
},
},
},
"client": { # Options related to how clients making requests on behalf of a project should be configured. # Options related to how clients making requests on behalf of a project should be configured.
"apiKey": "A String", # Output only. API key that can be used when making requests for this project.
"firebaseSubdomain": "A String", # Output only. Firebase subdomain.
"permissions": { # Configuration related to restricting a user's ability to affect their account. # Configuration related to restricting a user's ability to affect their account.
"disabledUserDeletion": True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
"disabledUserSignup": True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
},
},
"defaultHostingSite": "A String", # Output only. Default Firebase hosting site name
"emailPrivacyConfig": { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
"enableImprovedEmailPrivacy": True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user's email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
},
"mfa": { # Options related to MultiFactor Authentication for the project. # Configuration for this project's multi-factor authentication, including whether it is active and what factors can be used for the second factor
"enabledProviders": [ # A list of usable second factors for this project.
"A String",
],
"providerConfigs": [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the 'enabled_providers' field.
{ # ProviderConfig describes the supported MFA providers along with their configurations.
"state": "A String", # Describes the state of the MultiFactor Authentication type.
"totpProviderConfig": { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
"adjacentIntervals": 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
},
},
],
"state": "A String", # Whether MultiFactor Authentication has been enabled for this project.
},
"mobileLinksConfig": { # Configuration mobile links. # Configuration for settings related to univeral links (iOS) and app links (Android).
"domain": "A String", # Open code in app domain to use for app links and universal links.
},
"monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
"requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
"enabled": True or False, # Whether logging is enabled for this project or not.
},
},
"multiTenant": { # Configuration related to multi-tenant functionality. # Configuration related to multi-tenant functionality.
"allowTenants": True or False, # Whether this project can have tenants or not.
"defaultTenantLocation": "A String", # The default cloud parent org or folder that the tenant project should be created under. The parent resource name should be in the format of "/", such as "folders/123" or "organizations/456". If the value is not set, the tenant will be created under the same organization or folder as the agent project.
},
"name": "A String", # Output only. The name of the Config resource. Example: "projects/my-awesome-project/config"
"notification": { # Configuration related to sending notifications to users. # Configuration related to sending notifications to users.
"defaultLocale": "A String", # Default locale used for email and SMS in IETF BCP 47 format.
"sendEmail": { # Options for email sending. # Options for email sending.
"callbackUri": "A String", # action url in email template.
"changeEmailTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for change email
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"dnsInfo": { # Information of custom domain DNS verification. By default, default_domain will be used. A custom domain can be configured using VerifyCustomDomain. # Information of custom domain DNS verification.
"customDomain": "A String", # Output only. The applied verified custom domain.
"customDomainState": "A String", # Output only. The current verification state of the custom domain. The custom domain will only be used once the domain verification is successful.
"domainVerificationRequestTime": "A String", # Output only. The timestamp of initial request for the current domain verification.
"pendingCustomDomain": "A String", # Output only. The custom domain that's to be verified.
"useCustomDomain": True or False, # Whether to use custom domain.
},
"legacyResetPasswordTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Reset password email template for legacy Firebase V1 app.
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"method": "A String", # The method used for sending an email.
"resetPasswordTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for reset password
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"revertSecondFactorAdditionTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for reverting second factor addition emails
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"smtp": { # Configuration for SMTP relay # Use a custom SMTP relay
"host": "A String", # SMTP relay host
"password": "A String", # SMTP relay password
"port": 42, # SMTP relay port
"securityMode": "A String", # SMTP security mode.
"senderEmail": "A String", # Sender email for the SMTP relay
"username": "A String", # SMTP relay username
},
"verifyEmailTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for verify email
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
},
"sendSms": { # Options for SMS sending. # Options for SMS sending.
"smsTemplate": { # The template to use when sending an SMS. # Output only. The template to use when sending an SMS.
"content": "A String", # Output only. The SMS's content. Can contain the following placeholders which will be replaced with the appropriate values: %APP_NAME% - For Android or iOS apps, the app's display name. For web apps, the domain hosting the application. %LOGIN_CODE% - The OOB code being sent in the SMS.
},
"useDeviceLocale": True or False, # Whether to use the accept_language header for SMS.
},
},
"passwordPolicyConfig": { # The configuration for the password policy on the project. # The project level password policy configuration.
"forceUpgradeOnSignin": True or False, # Users must have a password compliant with the password policy to sign-in.
"lastUpdateTime": "A String", # Output only. The last time the password policy on the project was updated.
"passwordPolicyEnforcementState": "A String", # Which enforcement mode to use for the password policy.
"passwordPolicyVersions": [ # Must be of length 1. Contains the strength attributes for the password policy.
{ # The strength attributes for the password policy on the project.
"customStrengthOptions": { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
"containsLowercaseCharacter": True or False, # The password must contain a lower case character.
"containsNonAlphanumericCharacter": True or False, # The password must contain a non alpha numeric character.
"containsNumericCharacter": True or False, # The password must contain a number.
"containsUppercaseCharacter": True or False, # The password must contain an upper case character.
"maxPasswordLength": 42, # Maximum password length. No default max length
"minPasswordLength": 42, # Minimum password length. Range from 6 to 30
},
"schemaVersion": 42, # Output only. schema version number for the password policy
},
],
},
"quota": { # Configuration related to quotas. # Configuration related to quotas.
"signUpQuotaConfig": { # Temporary quota increase / decrease # Quota for the Signup endpoint, if overwritten. Signup quota is measured in sign ups per project per hour per IP.
"quota": "A String", # Corresponds to the 'refill_token_count' field in QuotaServer config
"quotaDuration": "A String", # How long this quota will be active for
"startTime": "A String", # When this quota will take effect
},
},
"recaptchaConfig": { # The reCAPTCHA Enterprise integration config. # The project-level reCAPTCHA config.
"emailPasswordEnforcementState": "A String", # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
"managedRules": [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
{ # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
"action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
},
],
"phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
"recaptchaKeys": [ # The reCAPTCHA keys.
{ # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
"key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}"
"type": "A String", # The client's platform type.
},
],
"tollFraudManagedRules": [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
{ # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
"action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
"startScore": 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
},
],
"useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
"useSmsBotScore": True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
"useSmsTollFraudProtection": True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
},
"signIn": { # Configuration related to local sign in methods. # Configuration related to local sign in methods.
"allowDuplicateEmails": True or False, # Whether to allow more than one account to have the same email.
"anonymous": { # Configuration options related to authenticating an anonymous user. # Configuration options related to authenticating an anonymous user.
"enabled": True or False, # Whether anonymous user auth is enabled for the project or not.
},
"email": { # Configuration options related to authenticating a user by their email address. # Configuration options related to authenticating a user by their email address.
"enabled": True or False, # Whether email auth is enabled for the project or not.
"passwordRequired": True or False, # Whether a password is required for email auth or not. If true, both an email and password must be provided to sign in. If false, a user may sign in via either email/password or email link.
},
"hashConfig": { # History information of the hash algorithm and key. Different accounts' passwords may be generated by different version. # Output only. Hash config information.
"algorithm": "A String", # Output only. Different password hash algorithms used in Identity Toolkit.
"memoryCost": 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
"rounds": 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
"saltSeparator": "A String", # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
"signerKey": "A String", # Output only. Signer key in base64.
},
"phoneNumber": { # Configuration options related to authenticated a user by their phone number. # Configuration options related to authenticated a user by their phone number.
"enabled": True or False, # Whether phone number auth is enabled for the project or not.
"testPhoneNumbers": { # A map of that can be used for phone auth testing.
"a_key": "A String",
},
},
},
"smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
"allowByDefault": { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
"disallowedRegions": [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
"A String",
],
},
"allowlistOnly": { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
"allowedRegions": [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
"A String",
],
},
},
"subtype": "A String", # Output only. The subtype of this config.
}
updateMask: string, The update mask applies to the resource. Fields set in the config but not included in this update mask will be ignored. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Identity Toolkit project.
"authorizedDomains": [ # List of domains authorized for OAuth redirects
"A String",
],
"autodeleteAnonymousUsers": True or False, # Whether anonymous users will be auto-deleted after a period of 30 days.
"blockingFunctions": { # Configuration related to Blocking Functions. # Configuration related to blocking functions.
"forwardInboundCredentials": { # Indicates which credentials to pass to the registered Blocking Functions. # The user credentials to include in the JWT payload that is sent to the registered Blocking Functions.
"accessToken": True or False, # Whether to pass the user's OAuth identity provider's access token.
"idToken": True or False, # Whether to pass the user's OIDC identity provider's ID token.
"refreshToken": True or False, # Whether to pass the user's OAuth identity provider's refresh token.
},
"triggers": { # Map of Trigger to event type. Key should be one of the supported event types: "beforeCreate", "beforeSignIn"
"a_key": { # Synchronous Cloud Function with HTTP Trigger
"functionUri": "A String", # HTTP URI trigger for the Cloud Function.
"updateTime": "A String", # When the trigger was changed.
},
},
},
"client": { # Options related to how clients making requests on behalf of a project should be configured. # Options related to how clients making requests on behalf of a project should be configured.
"apiKey": "A String", # Output only. API key that can be used when making requests for this project.
"firebaseSubdomain": "A String", # Output only. Firebase subdomain.
"permissions": { # Configuration related to restricting a user's ability to affect their account. # Configuration related to restricting a user's ability to affect their account.
"disabledUserDeletion": True or False, # When true, end users cannot delete their account on the associated project through any of our API methods
"disabledUserSignup": True or False, # When true, end users cannot sign up for a new account on the associated project through any of our API methods
},
},
"defaultHostingSite": "A String", # Output only. Default Firebase hosting site name
"emailPrivacyConfig": { # Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. # Configuration for settings related to email privacy and public visibility.
"enableImprovedEmailPrivacy": True or False, # Migrates the project to a state of improved email privacy. For example certain error codes are more generic to avoid giving away information on whether the account exists. In addition, this disables certain features that as a side-effect allow user enumeration. Enabling this toggle disables the fetchSignInMethodsForEmail functionality and changing the user's email to an unverified email. It is recommended to remove dependence on this functionality and enable this toggle to improve user privacy.
},
"mfa": { # Options related to MultiFactor Authentication for the project. # Configuration for this project's multi-factor authentication, including whether it is active and what factors can be used for the second factor
"enabledProviders": [ # A list of usable second factors for this project.
"A String",
],
"providerConfigs": [ # A list of usable second factors for this project along with their configurations. This field does not support phone based MFA, for that use the 'enabled_providers' field.
{ # ProviderConfig describes the supported MFA providers along with their configurations.
"state": "A String", # Describes the state of the MultiFactor Authentication type.
"totpProviderConfig": { # TotpMFAProviderConfig represents the TOTP based MFA provider. # TOTP MFA provider config for this project.
"adjacentIntervals": 42, # The allowed number of adjacent intervals that will be used for verification to avoid clock skew.
},
},
],
"state": "A String", # Whether MultiFactor Authentication has been enabled for this project.
},
"mobileLinksConfig": { # Configuration mobile links. # Configuration for settings related to univeral links (iOS) and app links (Android).
"domain": "A String", # Open code in app domain to use for app links and universal links.
},
"monitoring": { # Configuration related to monitoring project activity. # Configuration related to monitoring project activity.
"requestLogging": { # Configuration for logging requests made to this project to Stackdriver Logging # Configuration for logging requests made to this project to Stackdriver Logging
"enabled": True or False, # Whether logging is enabled for this project or not.
},
},
"multiTenant": { # Configuration related to multi-tenant functionality. # Configuration related to multi-tenant functionality.
"allowTenants": True or False, # Whether this project can have tenants or not.
"defaultTenantLocation": "A String", # The default cloud parent org or folder that the tenant project should be created under. The parent resource name should be in the format of "/", such as "folders/123" or "organizations/456". If the value is not set, the tenant will be created under the same organization or folder as the agent project.
},
"name": "A String", # Output only. The name of the Config resource. Example: "projects/my-awesome-project/config"
"notification": { # Configuration related to sending notifications to users. # Configuration related to sending notifications to users.
"defaultLocale": "A String", # Default locale used for email and SMS in IETF BCP 47 format.
"sendEmail": { # Options for email sending. # Options for email sending.
"callbackUri": "A String", # action url in email template.
"changeEmailTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for change email
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"dnsInfo": { # Information of custom domain DNS verification. By default, default_domain will be used. A custom domain can be configured using VerifyCustomDomain. # Information of custom domain DNS verification.
"customDomain": "A String", # Output only. The applied verified custom domain.
"customDomainState": "A String", # Output only. The current verification state of the custom domain. The custom domain will only be used once the domain verification is successful.
"domainVerificationRequestTime": "A String", # Output only. The timestamp of initial request for the current domain verification.
"pendingCustomDomain": "A String", # Output only. The custom domain that's to be verified.
"useCustomDomain": True or False, # Whether to use custom domain.
},
"legacyResetPasswordTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Reset password email template for legacy Firebase V1 app.
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"method": "A String", # The method used for sending an email.
"resetPasswordTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for reset password
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"revertSecondFactorAdditionTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for reverting second factor addition emails
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
"smtp": { # Configuration for SMTP relay # Use a custom SMTP relay
"host": "A String", # SMTP relay host
"password": "A String", # SMTP relay password
"port": 42, # SMTP relay port
"securityMode": "A String", # SMTP security mode.
"senderEmail": "A String", # Sender email for the SMTP relay
"username": "A String", # SMTP relay username
},
"verifyEmailTemplate": { # Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The Google Cloud project's display name. %DISPLAY_NAME% - The user's display name. # Email template for verify email
"body": "A String", # Email body
"bodyFormat": "A String", # Email body format
"customized": True or False, # Output only. Whether the body or subject of the email is customized.
"replyTo": "A String", # Reply-to address
"senderDisplayName": "A String", # Sender display name
"senderLocalPart": "A String", # Local part of From address
"subject": "A String", # Subject of the email
},
},
"sendSms": { # Options for SMS sending. # Options for SMS sending.
"smsTemplate": { # The template to use when sending an SMS. # Output only. The template to use when sending an SMS.
"content": "A String", # Output only. The SMS's content. Can contain the following placeholders which will be replaced with the appropriate values: %APP_NAME% - For Android or iOS apps, the app's display name. For web apps, the domain hosting the application. %LOGIN_CODE% - The OOB code being sent in the SMS.
},
"useDeviceLocale": True or False, # Whether to use the accept_language header for SMS.
},
},
"passwordPolicyConfig": { # The configuration for the password policy on the project. # The project level password policy configuration.
"forceUpgradeOnSignin": True or False, # Users must have a password compliant with the password policy to sign-in.
"lastUpdateTime": "A String", # Output only. The last time the password policy on the project was updated.
"passwordPolicyEnforcementState": "A String", # Which enforcement mode to use for the password policy.
"passwordPolicyVersions": [ # Must be of length 1. Contains the strength attributes for the password policy.
{ # The strength attributes for the password policy on the project.
"customStrengthOptions": { # Custom strength options to enforce on user passwords. # The custom strength options enforced by the password policy.
"containsLowercaseCharacter": True or False, # The password must contain a lower case character.
"containsNonAlphanumericCharacter": True or False, # The password must contain a non alpha numeric character.
"containsNumericCharacter": True or False, # The password must contain a number.
"containsUppercaseCharacter": True or False, # The password must contain an upper case character.
"maxPasswordLength": 42, # Maximum password length. No default max length
"minPasswordLength": 42, # Minimum password length. Range from 6 to 30
},
"schemaVersion": 42, # Output only. schema version number for the password policy
},
],
},
"quota": { # Configuration related to quotas. # Configuration related to quotas.
"signUpQuotaConfig": { # Temporary quota increase / decrease # Quota for the Signup endpoint, if overwritten. Signup quota is measured in sign ups per project per hour per IP.
"quota": "A String", # Corresponds to the 'refill_token_count' field in QuotaServer config
"quotaDuration": "A String", # How long this quota will be active for
"startTime": "A String", # When this quota will take effect
},
},
"recaptchaConfig": { # The reCAPTCHA Enterprise integration config. # The project-level reCAPTCHA config.
"emailPasswordEnforcementState": "A String", # The reCAPTCHA config for email/password provider, containing the enforcement status. The email/password provider contains all email related user flows protected by reCAPTCHA.
"managedRules": [ # The managed rules for authentication action based on reCAPTCHA scores. The rules are shared across providers for a given tenant project.
{ # The config for a reCAPTCHA managed rule. Models a single interval [start_score, end_score]. The start_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
"action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
"endScore": 3.14, # The end score (inclusive) of the score range for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the riskiest request (likely a bot), whereas 1.0 indicates the safest request (likely a human). See https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.
},
],
"phoneEnforcementState": "A String", # The reCAPTCHA config for phone provider, containing the enforcement status. The phone provider contains all SMS related user flows protected by reCAPTCHA.
"recaptchaKeys": [ # The reCAPTCHA keys.
{ # The reCAPTCHA key config. reCAPTCHA Enterprise offers different keys for different client platforms.
"key": "A String", # The reCAPTCHA Enterprise key resource name, e.g. "projects/{project}/keys/{key}"
"type": "A String", # The client's platform type.
},
],
"tollFraudManagedRules": [ # The managed rules for the authentication action based on reCAPTCHA toll fraud risk scores. Toll fraud managed rules will only take effect when the phone_enforcement_state is AUDIT or ENFORCE and use_sms_toll_fraud_protection is true.
{ # The config for a reCAPTCHA toll fraud assessment managed rule. Models a single interval [start_score, end_score]. The end_score is implicit. It is either the closest smaller end_score (if one is available) or 0. Intervals in aggregate span [0, 1] without overlapping.
"action": "A String", # The action taken if the reCAPTCHA score of a request is within the interval [start_score, end_score].
"startScore": 3.14, # The start score (inclusive) for an action. Must be a value between 0.0 and 1.0, at 11 discrete values; e.g. 0, 0.1, 0.2, 0.3, ... 0.9, 1.0. A score of 0.0 indicates the safest request (likely legitimate), whereas 1.0 indicates the riskiest request (likely toll fraud). See https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.
},
],
"useAccountDefender": True or False, # Whether to use the account defender for reCAPTCHA assessment. Defaults to `false`.
"useSmsBotScore": True or False, # Whether to use the rCE bot score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
"useSmsTollFraudProtection": True or False, # Whether to use the rCE sms toll fraud protection risk score for reCAPTCHA phone provider. Can only be true when the phone_enforcement_state is AUDIT or ENFORCE.
},
"signIn": { # Configuration related to local sign in methods. # Configuration related to local sign in methods.
"allowDuplicateEmails": True or False, # Whether to allow more than one account to have the same email.
"anonymous": { # Configuration options related to authenticating an anonymous user. # Configuration options related to authenticating an anonymous user.
"enabled": True or False, # Whether anonymous user auth is enabled for the project or not.
},
"email": { # Configuration options related to authenticating a user by their email address. # Configuration options related to authenticating a user by their email address.
"enabled": True or False, # Whether email auth is enabled for the project or not.
"passwordRequired": True or False, # Whether a password is required for email auth or not. If true, both an email and password must be provided to sign in. If false, a user may sign in via either email/password or email link.
},
"hashConfig": { # History information of the hash algorithm and key. Different accounts' passwords may be generated by different version. # Output only. Hash config information.
"algorithm": "A String", # Output only. Different password hash algorithms used in Identity Toolkit.
"memoryCost": 42, # Output only. Memory cost for hash calculation. Used by scrypt and other similar password derivation algorithms. See https://tools.ietf.org/html/rfc7914 for explanation of field.
"rounds": 42, # Output only. How many rounds for hash calculation. Used by scrypt and other similar password derivation algorithms.
"saltSeparator": "A String", # Output only. Non-printable character to be inserted between the salt and plain text password in base64.
"signerKey": "A String", # Output only. Signer key in base64.
},
"phoneNumber": { # Configuration options related to authenticated a user by their phone number. # Configuration options related to authenticated a user by their phone number.
"enabled": True or False, # Whether phone number auth is enabled for the project or not.
"testPhoneNumbers": { # A map of that can be used for phone auth testing.
"a_key": "A String",
},
},
},
"smsRegionConfig": { # Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. # Configures which regions are enabled for SMS verification code sending.
"allowByDefault": { # Defines a policy of allowing every region by default and adding disallowed regions to a disallow list. # A policy of allowing SMS to every region by default and adding disallowed regions to a disallow list.
"disallowedRegions": [ # Two letter unicode region codes to disallow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
"A String",
],
},
"allowlistOnly": { # Defines a policy of only allowing regions by explicitly adding them to an allowlist. # A policy of only allowing regions by explicitly adding them to an allowlist.
"allowedRegions": [ # Two letter unicode region codes to allow as defined by https://cldr.unicode.org/ The full list of these region codes is here: https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
"A String",
],
},
},
"subtype": "A String", # Output only. The subtype of this config.
}</pre>
</div>
</body></html>
|
