enable method
- EnableCseKeyPairRequest request,
- String userId,
- String keyPairId, {
- String? $fields,
Turns on a client-side encryption key pair that was turned off.
The key pair becomes active again for any associated client-side
encryption identities. For administrators managing identities and keypairs
for users in their organization, requests require authorization with a
service account
that has [domain-wide delegation
authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority)
to impersonate users with the
https://www.googleapis.com/auth/gmail.settings.basic
scope. For users
managing their own identities and keypairs, requests require
hardware key encryption
turned on and configured.
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 on.
$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> enable(
EnableCseKeyPairRequest 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') +
':enable';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return CseKeyPair.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}