sendOobCode method

Sends an out-of-band confirmation code for an account.

Requests from a authenticated request can optionally return a link including the OOB code instead of sending it.

request - The metadata request object.

Request parameters:

targetProjectId - The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper permissions. Value must have pattern ^\[^/\]+$.

tenantId - The tenant ID of the Identity Platform tenant the account belongs to. Value must have pattern ^\[^/\]+$.

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

Completes with a GoogleCloudIdentitytoolkitV1GetOobCodeResponse.

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<GoogleCloudIdentitytoolkitV1GetOobCodeResponse> sendOobCode(
  GoogleCloudIdentitytoolkitV1GetOobCodeRequest request,
  core.String targetProjectId,
  core.String tenantId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/projects/' +
      core.Uri.encodeFull('$targetProjectId') +
      '/tenants/' +
      core.Uri.encodeFull('$tenantId') +
      '/accounts:sendOobCode';

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