/** * @example * { * id: "id" * } */ export interface UpdateApiKeysRequest { /** API key ID, prefixed `apik_`. */ id: string; /** Dated API version used when requests authenticated with this key omit the `Api-Version-Date` header. New keys default to the latest version. */ api_version_date?: UpdateApiKeysRequest.ApiVersionDate; /** When the API key should stop working, as an ISO 8601 timestamp. Omit (or pass `null` on update) for a key that never expires. */ expires_at?: string | null; /** IPv4/IPv6 CIDR ranges allowed to use this key, for example `["203.0.113.0/24"]`. Empty or `null` allows any IP. */ ip_allowlist?: string[] | null; /** A new human-readable name for the API key. */ name?: string | null; /** The permissions policy for the API key: explicit permission statements, or a system role to inherit from. Statements without a `resources` array default to the owning account (Account API keys) or every key-addressable resource (App API keys). */ permissions?: UpdateApiKeysRequest.Permissions; } export declare namespace UpdateApiKeysRequest { /** Dated API version used when requests authenticated with this key omit the `Api-Version-Date` header. New keys default to the latest version. */ const ApiVersionDate: { readonly TwoThousandTwentyFive0101: "2025-01-01"; readonly TwoThousandTwentySix0608: "2026-06-08"; readonly TwoThousandTwentySix0609: "2026-06-09"; readonly TwoThousandTwentySix0620: "2026-06-20"; readonly TwoThousandTwentySix0701: "2026-07-01"; readonly TwoThousandTwentySix0708: "2026-07-08"; readonly TwoThousandTwentySix07081: "2026-07-08-1"; readonly TwoThousandTwentySix0718: "2026-07-18"; readonly TwoThousandTwentySix0720: "2026-07-20"; readonly TwoThousandTwentySix0722: "2026-07-22"; readonly TwoThousandTwentySix0723: "2026-07-23"; readonly TwoThousandTwentySix0725: "2026-07-25"; readonly TwoThousandTwentySix0726: "2026-07-26"; readonly TwoThousandTwentySix0727: "2026-07-27"; readonly TwoThousandTwentySix0729: "2026-07-29"; readonly TwoThousandTwentySix07291: "2026-07-29-1"; readonly TwoThousandTwentySix0731: "2026-07-31"; readonly TwoThousandTwentySix0803: "2026-08-03"; readonly TwoThousandTwentySix0805: "2026-08-05"; readonly TwoThousandTwentySix08051: "2026-08-05-1"; readonly TwoThousandTwentySix0810: "2026-08-10"; readonly TwoThousandTwentySix0812: "2026-08-12"; readonly TwoThousandTwentySix0813: "2026-08-13"; readonly TwoThousandTwentySix0814: "2026-08-14"; readonly TwoThousandTwentySix0821: "2026-08-21"; readonly TwoThousandTwentySix08211: "2026-08-21-1"; readonly TwoThousandTwentySix0825: "2026-08-25"; readonly TwoThousandTwentySix08251: "2026-08-25-1"; readonly TwoThousandTwentySix08252: "2026-08-25-2"; readonly TwoThousandTwentySix0831: "2026-08-31"; readonly TwoThousandTwentySix0902: "2026-09-02"; readonly TwoThousandTwentySix09021: "2026-09-02-1"; readonly TwoThousandTwentySix09022: "2026-09-02-2"; readonly TwoThousandTwentySix0904: "2026-09-04"; readonly TwoThousandTwentySix0906: "2026-09-06"; readonly TwoThousandTwentySix0909: "2026-09-09"; readonly TwoThousandTwentySix09091: "2026-09-09-1"; readonly TwoThousandTwentySix0911: "2026-09-11"; readonly TwoThousandTwentySix09111: "2026-09-11-1"; readonly TwoThousandTwentySix0913: "2026-09-13"; readonly TwoThousandTwentySix0915: "2026-09-15"; readonly TwoThousandTwentySix0922: "2026-09-22"; readonly TwoThousandTwentySix09221: "2026-09-22-1"; readonly TwoThousandTwentySix09222: "2026-09-22-2"; readonly TwoThousandTwentySix09223: "2026-09-22-3"; readonly TwoThousandTwentySix09224: "2026-09-22-4"; readonly TwoThousandTwentySix0923: "2026-09-23"; readonly TwoThousandTwentySix0924: "2026-09-24"; readonly TwoThousandTwentySix09241: "2026-09-24-1"; readonly TwoThousandTwentySix0925: "2026-09-25"; readonly TwoThousandTwentySix0928: "2026-09-28"; readonly TwoThousandTwentySix0929: "2026-09-29"; readonly TwoThousandTwentySix1005: "2026-10-05"; readonly TwoThousandTwentySix10051: "2026-10-05-1"; readonly TwoThousandTwentySix1006: "2026-10-06"; readonly TwoThousandTwentySix10061: "2026-10-06-1"; readonly TwoThousandTwentySix10062: "2026-10-06-2"; readonly TwoThousandTwentySix1007: "2026-10-07"; readonly TwoThousandTwentySix10071: "2026-10-07-1"; readonly TwoThousandTwentySix10072: "2026-10-07-2"; readonly TwoThousandTwentySix1008: "2026-10-08"; readonly TwoThousandTwentySix1009: "2026-10-09"; readonly TwoThousandTwentySix10091: "2026-10-09-1"; readonly TwoThousandTwentySix10092: "2026-10-09-2"; readonly TwoThousandTwentySix1013: "2026-10-13"; readonly TwoThousandTwentySix10131: "2026-10-13-1"; readonly TwoThousandTwentySix1014: "2026-10-14"; readonly TwoThousandTwentySix10141: "2026-10-14-1"; readonly TwoThousandTwentySix1015: "2026-10-15"; readonly TwoThousandTwentySix10151: "2026-10-15-1"; readonly TwoThousandTwentySix1024: "2026-10-24"; readonly TwoThousandTwentySix1027: "2026-10-27"; readonly TwoThousandTwentySix10271: "2026-10-27-1"; readonly TwoThousandTwentySix10272: "2026-10-27-2"; readonly TwoThousandTwentySix10273: "2026-10-27-3"; readonly TwoThousandTwentySix1028: "2026-10-28"; }; type ApiVersionDate = (typeof ApiVersionDate)[keyof typeof ApiVersionDate]; /** * The permissions policy for the API key: explicit permission statements, or a system role to inherit from. Statements without a `resources` array default to the owning account (Account API keys) or every key-addressable resource (App API keys). */ interface Permissions { /** Explicit permission statements. Required unless `system_role` is set. */ statements?: Permissions.Statements.Item[] | undefined; /** A system role to inherit permissions from. Only Account API keys can use a system role. */ system_role?: (Permissions.SystemRole | null) | undefined; } namespace Permissions { type Statements = Statements.Item[]; namespace Statements { interface Item { /** Permission actions covered by this statement, for example `company:basic:read`. */ actions: string[]; /** Whether the actions are granted (`true`) or denied (`false`). */ grant: boolean; /** Resource identifiers the statement applies to, for example `biz_xxx` or `biz_xxx|pass_*`. Defaults to the key's owning resource when omitted. */ resources?: string[] | undefined; } } /** A system role to inherit permissions from. Only Account API keys can use a system role. */ const SystemRole: { readonly Owner: "owner"; readonly Admin: "admin"; readonly Moderator: "moderator"; readonly SalesManager: "sales_manager"; readonly Advertiser: "advertiser"; }; type SystemRole = (typeof SystemRole)[keyof typeof SystemRole]; } }