signInWithPhoneNumber method

Completes a phone number authentication attempt.

If a user already exists with the given phone number, an ID token is minted for that user. Otherwise, a new user is created and associated with the phone number. This method may also be used to link a phone number to an existing user. An API key is required in the request in order to identify the Google Cloud project.

request - The metadata request object.

Request parameters:

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse>
    signInWithPhoneNumber(
  GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest request, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'v1/accounts:signInWithPhoneNumber';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}