Identity Toolkit API . accounts . passkeySignIn

Instance Methods

close()

Close httplib2 connections.

finalize(body=None, x__xgafv=None)

Verifies the passkey assertion and signs the user in.

start(body=None, x__xgafv=None)

Creates and returns the passkey challenge

Method Details

close()
Close httplib2 connections.
finalize(body=None, x__xgafv=None)
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.
  "authenticatorAuthenticationResponse": { # Authenticator response to authenticate the user with an existing FIDO key. # Required. The authentication response object from the authenticator.
    "authenticatorAssertionResponse": { # Authentication response from a FIDO authenticator. # Authentication assertion from the authenticator.
      "authenticatorData": "A String", # The AuthenticatorData from the authenticator.
      "clientDataJson": "A String", # The CollectedClientData object from the authenticator.
      "signature": "A String", # The signature from the authenticator.
      "userHandle": "A String", # The user handle.
    },
    "credentialId": "A String", # Identifier for the authentication credential.
    "credentialType": "A String", # The type of public key.
  },
  "sessionId": "A String", # Optional. The session ID that was passed into StartPasskeySignIn, if any.
  "tenantId": "A String", # 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.
  "idToken": "A String", # ID token for the authenticated user.
  "refreshToken": "A String", # Refresh token for the authenticated user.
}
start(body=None, x__xgafv=None)
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.
  "sessionId": "A String", # Optional. The developer can bind their own concept of a user session to this flow.
  "tenantId": "A String", # 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.
  "credentialRequestOptions": { # Parameters for signing a challenge with a FIDO key. # Parameters specified for the authenticator to sign a challenge.
    "challenge": "A String", # The FIDO challenge.
    "rpId": "A String", # The relying party identifier.
    "userVerification": "A String", # The requirements regarding user verification.
  },
}