Type Alias: SanctionResponse
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Sanction ID |
tenantId | string | Yes | Tenant ID |
participantId | string | No | Participant ID (if session-scoped) |
externalUserId | string | No | External user ID |
sessionId | string | No | Session 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" | Yes | Type of sanction |
scope | object | No | Scope configuration |
reason | string | No | Reason for sanction |
metadata | object | No | Additional metadata |
startAt | string | Yes | When sanction becomes active |
endAt | string | No | When sanction expires (null = permanent) |
createdByUserId | string | No | User who created the sanction |
createdAt | string | Yes | Creation timestamp |
updatedAt | string | Yes | Last update timestamp |
revokedAt | string | No | When sanction was revoked |
revokedByUserId | string | No | User who revoked the sanction |
isActive | boolean | Yes | Whether the sanction is currently active |
status | string | Yes | Status: active, expired, or revoked |
participant | unknown | No | Participant information (if available) |
Defined in
4Players/cortex-typescript-sdk/src/resources/sanctions.ts:19