Skip to main content

AdminUpdateApiKeyDTO

Package: @nauth-toolkit/core Type: DTO (Request)

Administrative update of a user's API key (label and IP allowlist).

import { AdminUpdateApiKeyDTO } from '@nauth-toolkit/nestjs';

Properties​

PropertyTypeRequiredDescription with validation inline
substringYesTarget user sub (UUID v4).
keyIdstringYesExternal key identifier (UUID v4).
namestringNoNew label.
allowedIpsstring[]NoReplacement allowlist (empty clears restrictions).

Example​

{
"sub": "550e8400-...",
"keyId": "660e8400-...",
"allowedIps": ["203.0.113.5"]
}

Used By​