list method
Lists client-side encryption key pairs for an authenticated user.
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 parameters:
userId
- The requester's primary email address. To indicate the
authenticated user, you can use the special value me
.
pageSize
- The number of key pairs to return. If not provided, the page
size will default to 20 entries.
pageToken
- Pagination token indicating which page of key pairs to
return. If the token is not supplied, then the API will return the first
page of results.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListCseKeyPairsResponse.
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<ListCseKeyPairsResponse> list(
core.String userId, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ =
'gmail/v1/users/' +
commons.escapeVariable('$userId') +
'/settings/cse/keypairs';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListCseKeyPairsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}