Skip to main content

suspendAppAccess

Suspend a user's access to an app until a time: a timed ban that lifts by itself. Until then their gameplay tokens are refused with ACCESS_SUSPENDED (carrying suspendedUntil), and the tokens they hold for the app are deleted and their realtime sessions ended at once. The time must be in the future and at most 365 days away. The user must have an access record. Requires the 'manage_access_tiers' permission on the app; super admins bypass. REVERSIBLE early via unsuspendAppAccess.

suspendAppAccess(
  appId: BigInt!
  userId: BigInt!
  until: DateTime!
  idempotencyKey: String
): AppUserAccess!

Arguments​

suspendAppAccess.appId ● BigInt! non-null scalar​

Numeric id of the app.

suspendAppAccess.userId ● BigInt! non-null scalar​

Numeric id of the user to suspend.

suspendAppAccess.until ● DateTime! non-null scalar​

When the suspension lapses (ISO-8601, in the future). Access returns by itself then.

suspendAppAccess.idempotencyKey ● String scalar​

Optional idempotency key. Recommended for retries: replaying with the same key and identical arguments returns the first result instead of re-applying; the same key with different arguments returns IDEMPOTENCY_CONFLICT. Keys expire after 24h.

Type​

AppUserAccess object​

A user's entitlement to a specific app: whether (and via which tier) they may access it. At most one row per (app, user).