Skip to main content

User

No description

type User {
  userId: BigInt!
  email: String
  gamertag: String
  disambiguation: String
  state: String
  isConfirmed: Boolean!
  createdAt: DateTime!
  grantEarlyAccess: Boolean!
  grantEarlyAccessOverride: Boolean!
  orgId: BigInt
  externalId: String
  userType: String!
  isSuperAdmin: Boolean!
  permissionsForOrg(
    orgId: BigInt!
  ): [String!]!
}

Fields​

User.userId ● BigInt! non-null scalar​

Unique user id and primary key. BigInt serialized as a decimal string.

User.email ● String scalar​

Account email; null for anonymized/soft-deleted accounts.

User.gamertag ● String scalar​

Public display name; null if unset or anonymized. Unique in combination with disambiguation.

User.disambiguation ● String scalar​

Discriminator paired with gamertag to form a unique handle; null if unset.

User.state ● String scalar​

User-level state blob, base64-encoded binary (management-owned). Null when cleared.

User.isConfirmed ● Boolean! non-null scalar​

Whether the account email has been confirmed.

User.createdAt ● DateTime! non-null scalar​

Account creation timestamp (ISO-8601).

User.grantEarlyAccess ● Boolean! non-null scalar​

Whether the user qualifies for early access through normal eligibility (the free-play window/rollout).

User.grantEarlyAccessOverride ● Boolean! non-null scalar​

Admin override forcing early access on/off regardless of normal eligibility (set via setEarlyAccessOverride).

User.orgId ● BigInt scalar​

Organization the user belongs to, or null. BigInt serialized as a decimal string.

User.externalId ● String scalar​

External identity-provider id for federated accounts, or null.

User.userType ● String! non-null scalar​

Account type, e.g. "direct" or "deleted".

User.isSuperAdmin ● Boolean! non-null scalar​

Whether the user holds platform super-admin privileges (toggled via setSuperAdmin).

User.permissionsForOrg ● [String!]! non-null scalar​

The user's effective permission keys on the given org (empty if not a member; full set if super admin). Requires a valid bearer game token. NOTE: org permissions are management-owned, so in cks-game-api this currently resolves to an empty list — query cks-management-api for authoritative org permissions.

User.permissionsForOrg.orgId ● BigInt! non-null scalar​

Organization id (BigInt sent as a decimal string) to evaluate the user against.

Returned By​

me query ● setEarlyAccessOverride mutation ● setSuperAdmin mutation ● updateGamertag mutation ● updateUserState mutation ● updateUserType mutation ● user query

Member Of​

GameClientBootstrap object ● UsersPage object