disable method

Future<CseKeyPair> disable(DisableCseKeyPairRequest request, String userId, String keyPairId, { String? $fields, })

Turns off a client-side encryption key pair.

The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method.

request - The metadata request object.

Request parameters:

userId - The requester's primary email address. To indicate the authenticated user, you can use the special value me.

keyPairId - The identifier of the key pair to turn off.

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

Completes with a CseKeyPair.

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<CseKeyPair> disable(
  DisableCseKeyPairRequest request,
  core.String userId,
  core.String keyPairId, {
  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_ = 'gmail/v1/users/' +
      commons.escapeVariable('$userId') +
      '/settings/cse/keypairs/' +
      commons.escapeVariable('$keyPairId') +
      ':disable';

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