edit_service_account_api_key
Modify an existing service account API key to update its name, permissions, IP allowlist, character limit, or enabled status. This helps manage access and enforce usage limits.
Instructions
Edit Service Account Api Key
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| api_key_id | Yes | ||
| is_enabled | No | Whether to enable or disable the API key. | |
| allowed_ips | No | List of IP addresses or CIDR ranges allowed to use this API key. Each entry may be a CIDR range (e.g. '10.0.0.0/24') or a bare IP address (normalized to /32 or /128). On create, omit or pass null to allow all IPs. On update, omit to leave the allowlist unchanged, or pass "clear" to remove it. | |
| permissions | No | The permissions of the XI API. | |
| character_limit | No | The character limit of the XI API key. If provided this will limit the usage of this api key to n characters per month where n is the chosen value. Requests that incur charges will fail after reaching this monthly limit. | |
| service_account_user_id | Yes | ||
| third_party_disable_allowed | No | Whether the holder of this key may disable it via the self-disable endpoint. On create, omit or pass null to use the workspace's default (enabled for non-Enterprise plans, disabled for Enterprise plans). On update, omit to leave it unchanged, or pass "clear" to reset it to the workspace default. Onl |