delete method
Deletes a ServiceAccountKey.
Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key.
Request parameters:
name
- Required. The resource name of the service account key. Use one
of the following formats: *
projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}
*
projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}/keys/{KEY_ID}
As an
alternative, you can use the -
wildcard character instead of the project
ID: * projects/-/serviceAccounts/{EMAIL_ADDRESS}/keys/{KEY_ID}
*
projects/-/serviceAccounts/{UNIQUE_ID}/keys/{KEY_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 key
projects/-/serviceAccounts/fake@example.com/keys/fake-key
, 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/\[^/\]+/keys/\[^/\]+$
.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Empty.
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<Empty> delete(
core.String name, {
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$name');
final response_ = await _requester.request(
url_,
'DELETE',
queryParams: queryParams_,
);
return Empty.fromJson(response_ as core.Map<core.String, core.dynamic>);
}