LegalHold

A legal hold an operator set on an organization or on one account. While it applies, deleting a managed player it covers is refused with LEGAL_HOLD, a player’s own account deletion closes the account but keeps its content (and preserves its identity) until the hold is released, and no erasure runs. An organization’s hold covers its managed players. A released hold stays readable as the record.

type LegalHold {
  holdId: BigInt!
  orgId: BigInt
  userId: BigInt
  reason: String!
  setBy: BigInt!
  setAt: DateTime!
  releasedBy: BigInt
  releasedAt: DateTime
  active: Boolean!
}

Fields

LegalHold.holdId ● BigInt! non-null scalar

The hold.

LegalHold.orgId ● BigInt scalar

The organization held (its public id), or null for a hold on one account.

LegalHold.userId ● BigInt scalar

The account held, or null for a hold on an organization.

LegalHold.reason ● String! non-null scalar

Why, as the operator wrote it.

LegalHold.setBy ● BigInt! non-null scalar

The operator who set it.

LegalHold.setAt ● DateTime! non-null scalar

When it was set.

LegalHold.releasedBy ● BigInt scalar

The operator who released it, or null while it applies.

LegalHold.releasedAt ● DateTime scalar

When it was released, or null while it applies.

LegalHold.active ● Boolean! non-null scalar

Whether it applies now.

Returned By

legalHolds query ● releaseLegalHold mutation ● setLegalHold mutation