import_api_keys¶
Operation¶
async
¶
import_api_keys(input: ImportApiKeysInput, plugins: list[Plugin] | None = None) -> ImportApiKeysOutput
Import API keys from an external source, such as a CSV-formatted file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ImportApiKeysInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ImportApiKeysOutput
|
An instance of |
Input¶
dataclass
¶
The POST request to import API keys from an external source, such as a CSV-formatted file.
Attributes¶
class-attribute
instance-attribute
¶
body: bytes | None = None
The payload of the POST request to import API keys. For the payload format, see API Key File Format.
class-attribute
instance-attribute
¶
fail_on_warnings: bool = False
A query parameter to indicate whether to rollback ApiKey importation
(true) or not (false) when error is encountered.
class-attribute
instance-attribute
¶
format: ApiKeysFormat | None = None
A query parameter to specify the input format to imported API keys.
Currently, only the csv format is supported.