list method
Lists every ServiceAccountKey for a service account.
Request parameters:
name
- Required. The resource name of the service account. Use one of
the following formats: *
projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}
*
projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}
As an alternative, you
can use the -
wildcard character instead of the project ID: *
projects/-/serviceAccounts/{EMAIL_ADDRESS}
*
projects/-/serviceAccounts/{UNIQUE_ID}
When possible, avoid using the
-
wildcard character, because it can cause response messages to contain
misleading error codes. For example, if you try to access the service
account projects/-/serviceAccounts/fake@example.com
, which does not
exist, the response contains an HTTP 403 Forbidden
error instead of a
404 Not Found
error.
Value must have pattern ^projects/\[^/\]+/serviceAccounts/\[^/\]+$
.
keyTypes
- Filters the types of keys the user wants to include in the
list response. Duplicate key types are not allowed. If no key type is
provided, all keys are returned.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListServiceAccountKeysResponse.
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<ListServiceAccountKeysResponse> list(
core.String name, {
core.List<core.String>? keyTypes,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (keyTypes != null) 'keyTypes': keyTypes,
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name') + '/keys';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListServiceAccountKeysResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}