File: identitytoolkit_v2.accounts.passkeySignIn.html

package info (click to toggle)
python-googleapi 2.188.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 573,720 kB
  • sloc: python: 11,217; javascript: 249; sh: 114; makefile: 59
file content (159 lines) | stat: -rw-r--r-- 4,951 bytes parent folder | download | duplicates (2)
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
<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.accounts.html">accounts</a> . <a href="identitytoolkit_v2.accounts.passkeySignIn.html">passkeySignIn</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="#finalize">finalize(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Verifies the passkey assertion and signs the user in.</p>
<p class="toc_element">
  <code><a href="#start">start(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates and returns the passkey challenge</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="finalize">finalize(body=None, x__xgafv=None)</code>
  <pre>Verifies the passkey assertion and signs the user in.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Request to finalize a passkey sign-in.
  &quot;authenticatorAuthenticationResponse&quot;: { # Authenticator response to authenticate the user with an existing FIDO key. # Required. The authentication response object from the authenticator.
    &quot;authenticatorAssertionResponse&quot;: { # Authentication response from a FIDO authenticator. # Authentication assertion from the authenticator.
      &quot;authenticatorData&quot;: &quot;A String&quot;, # The AuthenticatorData from the authenticator.
      &quot;clientDataJson&quot;: &quot;A String&quot;, # The CollectedClientData object from the authenticator.
      &quot;signature&quot;: &quot;A String&quot;, # The signature from the authenticator.
      &quot;userHandle&quot;: &quot;A String&quot;, # The user handle.
    },
    &quot;credentialId&quot;: &quot;A String&quot;, # Identifier for the authentication credential.
    &quot;credentialType&quot;: &quot;A String&quot;, # The type of public key.
  },
  &quot;sessionId&quot;: &quot;A String&quot;, # Optional. The session ID that was passed into StartPasskeySignIn, if any.
  &quot;tenantId&quot;: &quot;A String&quot;, # Optional. The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for FinalizePasskeySignIn.
  &quot;idToken&quot;: &quot;A String&quot;, # ID token for the authenticated user.
  &quot;refreshToken&quot;: &quot;A String&quot;, # Refresh token for the authenticated user.
}</pre>
</div>

<div class="method">
    <code class="details" id="start">start(body=None, x__xgafv=None)</code>
  <pre>Creates and returns the passkey challenge

Args:
  body: object, The request body.
    The object takes the form of:

{ # Starts passkey sign-in by returning the FIDO challenge.
  &quot;sessionId&quot;: &quot;A String&quot;, # Optional. The developer can bind their own concept of a user session to this flow.
  &quot;tenantId&quot;: &quot;A String&quot;, # Optional. The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for StartPasskeySignIn.
  &quot;credentialRequestOptions&quot;: { # Parameters for signing a challenge with a FIDO key. # Parameters specified for the authenticator to sign a challenge.
    &quot;challenge&quot;: &quot;A String&quot;, # The FIDO challenge.
    &quot;rpId&quot;: &quot;A String&quot;, # The relying party identifier.
    &quot;userVerification&quot;: &quot;A String&quot;, # The requirements regarding user verification.
  },
}</pre>
</div>

</body></html>