Skip to content

ExchangeApiKeyTokenRequestBody

Example Usage

typescript
import { ExchangeApiKeyTokenRequestBody } from "@meetkai/mka1/models/operations";

let value: ExchangeApiKeyTokenRequestBody = {
  audience: "https://short-tackle.biz",
  externalUserId: "<id>",
};

Fields

FieldTypeRequiredDescription
audiencestring✔️JWT audience (aud) claim for the exchanged token. Set this to the target API/service URL that should accept the token.
externalUserIdstring✔️Your external user identifier to place in the JWT subject (sub) claim. Must be 1–150 printable-ASCII characters and not the wildcard *.
expiresInnumberToken lifetime in seconds. Must be between 300 (5 minutes) and 2592000 (30 days). Defaults to 3600 (1 hour).
permissionsstring[]Optional subset of the API key's scopes to embed in the token (e.g. read:responses). The exchanged token is attenuated to this set at the gateway perimeter. If omitted, all of the key's scopes are embedded (no attenuation).