Skip to main content

Type Alias: SanctionResponse

type SanctionResponse: components["schemas"]["SanctionResponse"];

Properties

PropertyTypeRequiredDescription
idstringYesSanction ID
tenantIdstringYesTenant ID
participantIdstringNoParticipant ID (if session-scoped)
externalUserIdstringNoExternal user ID
sessionIdstringNoSession ID (if session-scoped)
type"warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review"YesType of sanction
scopeobjectNoScope configuration
reasonstringNoReason for sanction
metadataobjectNoAdditional metadata
startAtstringYesWhen sanction becomes active
endAtstringNoWhen sanction expires (null = permanent)
createdByUserIdstringNoUser who created the sanction
createdAtstringYesCreation timestamp
updatedAtstringYesLast update timestamp
revokedAtstringNoWhen sanction was revoked
revokedByUserIdstringNoUser who revoked the sanction
isActivebooleanYesWhether the sanction is currently active
statusstringYesStatus: active, expired, or revoked
participantunknownNoParticipant information (if available)

Defined in

4Players/cortex-typescript-sdk/src/resources/sanctions.ts:19