updateApiKey method
Future<UpdateApiKeyResponse>
updateApiKey({
- required String key,
- required ApiKey apiKey,
- RequestOptions? requestOptions,
Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.
Required API Key ACLs:
- admin
Parameters:
key
API key.apiKey
requestOptions
additional request configuration.
Implementation
Future<UpdateApiKeyResponse> updateApiKey({
required String key,
required ApiKey apiKey,
RequestOptions? requestOptions,
}) async {
assert(
key.isNotEmpty,
'Parameter `key` is required when calling `updateApiKey`.',
);
final request = ApiRequest(
method: RequestMethod.put,
path: r'/1/keys/{key}'
.replaceAll('{' r'key' '}', Uri.encodeComponent(key.toString())),
body: apiKey.toJson(),
);
final response = await _retryStrategy.execute(
request: request,
options: requestOptions,
);
return deserialize<UpdateApiKeyResponse, UpdateApiKeyResponse>(
response,
'UpdateApiKeyResponse',
growable: true,
);
}