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
|
<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_v1.html">Identity Toolkit API</a> . <a href="identitytoolkit_v1.v1.html">v1</a></h1>
<h2>Instance Methods</h2>
<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="#getProjects">getProjects(androidPackageName=None, clientId=None, delegatedProjectNumber=None, firebaseAppId=None, iosBundleId=None, projectNumber=None, returnDynamicLink=None, sha1Cert=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a project's public Identity Toolkit configuration. (Legacy) This method also supports authenticated calls from a developer to retrieve non-public configuration.</p>
<p class="toc_element">
<code><a href="#getPublicKeys">getPublicKeys(x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves public keys of the legacy Identity Toolkit token signer to enable third parties to verify the legacy ID token. For now the X509 pem cert is the only format supported.</p>
<p class="toc_element">
<code><a href="#getRecaptchaParams">getRecaptchaParams(x__xgafv=None)</a></code></p>
<p class="firstline">Gets parameters needed for generating a reCAPTCHA challenge.</p>
<p class="toc_element">
<code><a href="#getSessionCookiePublicKeys">getSessionCookiePublicKeys(x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the set of public keys of the session cookie JSON Web Token (JWT) signer that can be used to validate the session cookie created through createSessionCookie.</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="getProjects">getProjects(androidPackageName=None, clientId=None, delegatedProjectNumber=None, firebaseAppId=None, iosBundleId=None, projectNumber=None, returnDynamicLink=None, sha1Cert=None, x__xgafv=None)</code>
<pre>Gets a project's public Identity Toolkit configuration. (Legacy) This method also supports authenticated calls from a developer to retrieve non-public configuration.
Args:
androidPackageName: string, Android package name to check against the real android package name. If this field is provided, and sha1_cert_hash is not provided, the action will throw an error if this does not match the real android package name.
clientId: string, The RP OAuth client ID. If set, a check will be performed to ensure that the OAuth client is valid for the retrieved project and the request rejected with a client error if not valid.
delegatedProjectNumber: string, Project Number of the delegated project request. This field should only be used as part of the Firebase V1 migration.
firebaseAppId: string, The Firebase app ID, for applications that use Firebase. This can be found in the Firebase console for your project. If set, a check will be performed to ensure that the app ID is valid for the retrieved project. If not valid, the request will be rejected with a client error.
iosBundleId: string, iOS bundle id to check against the real ios bundle id. If this field is provided, the action will throw an error if this does not match the real iOS bundle id.
projectNumber: string, Project number of the configuration to retrieve. This field is deprecated and should not be used by new integrations.
returnDynamicLink: boolean, Whether dynamic link should be returned.
sha1Cert: string, SHA-1 Android application cert hash. If set, a check will be performed to ensure that the cert hash is valid for the retrieved project and android_package_name.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for GetProjectConfig.
"allowPasswordUser": True or False, # Whether to allow password account sign up. This field is only returned for authenticated calls from a developer.
"apiKey": "A String", # Google Cloud API key. This field is only returned for authenticated calls from a developer.
"authorizedDomains": [ # Authorized domains for widget redirect.
"A String",
],
"changeEmailTemplate": { # Email template # Email template for change email. This field is only returned for authenticated calls from a developer.
"body": "A String", # Email body
"customized": True or False, # Whether the body or subject of the email is customized.
"disabled": True or False, # Whether the template is disabled. If true, a default template will be used.
"format": "A String", # Email body format
"from": "A String", # From address of the email
"fromDisplayName": "A String", # From display name
"fromLocalPart": "A String", # Local part of From address
"locale": "A String", # Value is in III language code format (e.g. "zh-CN", "es"). Both '-' and '_' separators are accepted.
"replyTo": "A String", # Reply-to address
"subject": "A String", # Subject of the email
},
"dynamicLinksDomain": "A String", # The Firebase Dynamic Links domain used to construct links for redirects to native apps.
"enableAnonymousUser": True or False, # Whether anonymous user is enabled. This field is only returned for authenticated calls from a developer.
"idpConfig": [ # OAuth2 provider config. This field is only returned for authenticated calls from a developer.
{ # Config of an identity provider.
"clientId": "A String", # OAuth2 client ID.
"enabled": True or False, # True if allows the user to sign in with the provider.
"experimentPercent": 42, # Percent of users who will be prompted/redirected federated login for this IdP
"provider": "A String",
"secret": "A String", # OAuth2 client secret.
"whitelistedAudiences": [ # Whitelisted client IDs for audience check.
"A String",
],
},
],
"legacyResetPasswordTemplate": { # Email template # Reset password email template for legacy Firebase V1 app. This field is only returned for authenticated calls from a developer.
"body": "A String", # Email body
"customized": True or False, # Whether the body or subject of the email is customized.
"disabled": True or False, # Whether the template is disabled. If true, a default template will be used.
"format": "A String", # Email body format
"from": "A String", # From address of the email
"fromDisplayName": "A String", # From display name
"fromLocalPart": "A String", # Local part of From address
"locale": "A String", # Value is in III language code format (e.g. "zh-CN", "es"). Both '-' and '_' separators are accepted.
"replyTo": "A String", # Reply-to address
"subject": "A String", # Subject of the email
},
"projectId": "A String", # The project id of the retrieved configuration.
"resetPasswordTemplate": { # Email template # Email template for reset password. This field is only returned for authenticated calls from a developer.
"body": "A String", # Email body
"customized": True or False, # Whether the body or subject of the email is customized.
"disabled": True or False, # Whether the template is disabled. If true, a default template will be used.
"format": "A String", # Email body format
"from": "A String", # From address of the email
"fromDisplayName": "A String", # From display name
"fromLocalPart": "A String", # Local part of From address
"locale": "A String", # Value is in III language code format (e.g. "zh-CN", "es"). Both '-' and '_' separators are accepted.
"replyTo": "A String", # Reply-to address
"subject": "A String", # Subject of the email
},
"revertSecondFactorAdditionTemplate": { # Email template # Email template for reverting second factor additions. This field is only returned for authenticated calls from a developer.
"body": "A String", # Email body
"customized": True or False, # Whether the body or subject of the email is customized.
"disabled": True or False, # Whether the template is disabled. If true, a default template will be used.
"format": "A String", # Email body format
"from": "A String", # From address of the email
"fromDisplayName": "A String", # From display name
"fromLocalPart": "A String", # Local part of From address
"locale": "A String", # Value is in III language code format (e.g. "zh-CN", "es"). Both '-' and '_' separators are accepted.
"replyTo": "A String", # Reply-to address
"subject": "A String", # Subject of the email
},
"useEmailSending": True or False, # Whether to use email sending. This field is only returned for authenticated calls from a developer.
"verifyEmailTemplate": { # Email template # Email template for verify email. This field is only returned for authenticated calls from a developer.
"body": "A String", # Email body
"customized": True or False, # Whether the body or subject of the email is customized.
"disabled": True or False, # Whether the template is disabled. If true, a default template will be used.
"format": "A String", # Email body format
"from": "A String", # From address of the email
"fromDisplayName": "A String", # From display name
"fromLocalPart": "A String", # Local part of From address
"locale": "A String", # Value is in III language code format (e.g. "zh-CN", "es"). Both '-' and '_' separators are accepted.
"replyTo": "A String", # Reply-to address
"subject": "A String", # Subject of the email
},
}</pre>
</div>
<div class="method">
<code class="details" id="getPublicKeys">getPublicKeys(x__xgafv=None)</code>
<pre>Retrieves public keys of the legacy Identity Toolkit token signer to enable third parties to verify the legacy ID token. For now the X509 pem cert is the only format supported.
Args:
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"a_key": "", # Properties of the object.
}</pre>
</div>
<div class="method">
<code class="details" id="getRecaptchaParams">getRecaptchaParams(x__xgafv=None)</code>
<pre>Gets parameters needed for generating a reCAPTCHA challenge.
Args:
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for GetRecaptchaParam.
"kind": "A String",
"producerProjectNumber": "A String", # The producer project number used to generate PIA tokens
"recaptchaSiteKey": "A String", # The reCAPTCHA v2 site key used to invoke the reCAPTCHA service. Always present.
"recaptchaStoken": "A String",
}</pre>
</div>
<div class="method">
<code class="details" id="getSessionCookiePublicKeys">getSessionCookiePublicKeys(x__xgafv=None)</code>
<pre>Retrieves the set of public keys of the session cookie JSON Web Token (JWT) signer that can be used to validate the session cookie created through createSessionCookie.
Args:
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for GetSessionCookiePublicKeys.
"keys": [ # Public keys of the session cookie signer, formatted as [JSON Web Keys (JWK)](https://tools.ietf.org/html/rfc7517).
{ # Represents a public key of the session cookie signer, formatted as a [JSON Web Key (JWK)](https://tools.ietf.org/html/rfc7517).
"alg": "A String", # Signature algorithm.
"e": "A String", # Exponent for the RSA public key, it is represented as the base64url encoding of the value's big endian representation.
"kid": "A String", # Unique string to identify this key.
"kty": "A String", # Key type.
"n": "A String", # Modulus for the RSA public key, it is represented as the base64url encoding of the value's big endian representation.
"use": "A String", # Key use.
},
],
}</pre>
</div>
</body></html>
|
