Identity Toolkit API . accounts . passkeyEnrollment

close()

Close httplib2 connections.

finalize(body=None, x__xgafv=None)

Finishes enrolling a passkey credential for the user.

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

{ # FinalizePasskeyEnrollment request. Registers passkey as a first factor for the user.
  "authenticatorRegistrationResponse": { # Authenticator response to register a new FIDO key. # Optional. The registration object from the authenticator.
    "authenticatorAttestationResponse": { # Attestation response from a FIDO authenticator. # The attestation response object as described in the spec.
      "attestationObject": "A String", # The attestation object from the authenticator.
      "clientDataJson": "A String", # The CollectedClientData object from the authenticator.
      "transports": [ # Authenticator transports that are supported by the authenticator.
        "A String",
      ],
    },
    "credentialId": "A String", # Identifier for the registered credential.
    "credentialType": "A String", # The type of credential.
  },
  "idToken": "A String", # Required. The GCIP ID token of the signed-in user
  "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:

    { # FinalizePasskeyEnrollment response.
  "idToken": "A String", # ID token for the authenticated user.
  "refreshToken": "A String", # Refresh token for the authenticated user.
}

start(body=None, x__xgafv=None)

Step one of the passkey enrollment process. Returns a challenge and parameters for creation of the passkey credential.

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

{ # Starts passkey enrollment for passkey as a first factor by returning the FIDO challenge.
  "idToken": "A String", # Required. The GCIP ID token of the signed-in user
  "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:

    { # StartPasskeyEnrollment response.
  "credentialCreationOptions": { # Parameters for creating a FIDO key. # Parameters specified for the authenticator to create a public key.
    "authenticatorSelection": { # Criteria for the authenticator to create a registered FIDO key. # Criteria for the authenticator to create a credential.
      "authenticatorAttachment": "A String", # The preferred authenticator attachment modality.
      "requireResidentKey": True or False, # Whether resident key is required.
      "userVerification": "A String", # The Relying Party's user verification requirements.
    },
    "challenge": "A String", # The FIDO challenge.
    "excludeCredentials": [ # Credentials already mapped to this user.
      { # Descriptor for a public key credential.
        "credentialId": "A String", # The identifier for the credential.
        "credentialType": "A String", # The type of public key.
        "transports": [ # Authenticator transports that are supported by the authenticator.
          "A String",
        ],
      },
    ],
    "pubKeyCredParams": [ # Lists the supported key types and signature algorithms.
      { # Parameters to create a public credential.
        "alg": "A String", # The COSE registry number of the cryptographic signature algorithm.
        "credentialType": "A String", # The type of public key to be created.
      },
    ],
    "rp": { # The entity object for the Relying Party. # The relying party attributes for creating a new credential.
      "id": "A String", # The RP ID of the FIDO Relying Party.
    },
    "user": { # The entity object for the user. # The user attributes for creating a new credential.
      "id": "A String", # The user ID.
    },
  },
}